Copyright 2016-2021 The Kubernetes Authors.
Generated at: 2021-08-11 10:59:31 (CEST)
API Version: v1.21.0

# 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:

- 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).
- 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. In most cases, users don't need to change this.

## 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.

# API Groups

The API Groups and their versions are summarized in the following table.

Group | Version
--- | ---
`admissionregistration.k8s.io` | `v1, v1beta1`
`apiextensions.k8s.io` | `v1, v1beta1`
`apiregistration.k8s.io` | `v1, v1beta1`
`apps` | `v1`
`authentication.k8s.io` | `v1, v1beta1`
`authorization.k8s.io` | `v1, v1beta1`
`autoscaling` | `v1, v2beta2, v2beta1`
`batch` | `v1, v1beta1`
`certificates.k8s.io` | `v1, v1beta1`
`coordination.k8s.io` | `v1, v1beta1`
`core` | `v1`
`discovery.k8s.io` | `v1, v1beta1`
`events.k8s.io` | `v1, v1beta1`
`policy` | `v1, v1beta1`
`extensions` | `v1beta1`
`flowcontrol.apiserver.k8s.io` | `v1beta1`
`internal.apiserver.k8s.io` | `v1alpha1`
`networking.k8s.io` | `v1, v1beta1`
`node.k8s.io` | `v1, v1beta1, v1alpha1`
`rbac.authorization.k8s.io` | `v1, v1beta1, v1alpha1`
`scheduling.k8s.io` | `v1, v1beta1, v1alpha1`
`storage.k8s.io` | `v1, v1beta1, v1alpha1`

# WORKLOADS

Workloads 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.14 image
    image: nginx:1.14

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

Warning:

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

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 strategy: 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 strategy: merge patch merge key: containerPort | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
`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/configuration/manage-resources-containers/
`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/
`startupProbe` Probe | StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
`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 strategy: merge patch merge key: devicePath | volumeDevices is the list of block devices to be used by the container.
`volumeMounts` VolumeMount array patch strategy: 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.
`started` boolean | Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined.
`state` ContainerState | Details about the container's current condition.

# CronJob v1 batch

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

Other API versions of this object exist: v1beta1
Appears In:

- CronJobList [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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#spec-and-status
`status` CronJobStatus | Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

### CronJobSpec v1 batch

Appears In:

- CronJob [batch/v1]

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. Value must be non-negative integer. 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. Value must be non-negative integer. 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 v1 batch

Appears In:

- CronJob [batch/v1]

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.
`lastSuccessfulTime` Time | Information when was the last time the job successfully completed.

### CronJobList 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a CronJob

### HTTP Request

`POST /apis/batch/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch

partially update the specified CronJob

### HTTP Request

`PATCH /apis/batch/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Replace

replace the specified CronJob

### HTTP Request

`PUT /apis/batch/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Delete

delete a CronJob

### HTTP Request

`DELETE /apis/batch/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of CronJob

### HTTP Request

`DELETE /apis/batch/v1/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified CronJob

### HTTP Request

`GET /apis/batch/v1/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.

### Response

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

## List

list or watch objects of kind CronJob

### HTTP Request

`GET /apis/batch/v1/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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind CronJob

### HTTP Request

`GET /apis/batch/v1/cronjobs`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/batch/v1/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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

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

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/batch/v1/watch/cronjobs`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified CronJob

### HTTP Request

`PATCH /apis/batch/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Read Status

read status of the specified CronJob

### HTTP Request

`GET /apis/batch/v1/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

replace status of the specified CronJob

### HTTP Request

`PUT /apis/batch/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

# DaemonSet v1 apps

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

    apiVersion: apps/v1
    kind: DaemonSet
    metadata:
      # Unique key of the DaemonSet instance
      name: daemonset-example
    spec:
      selector:
        matchLabels:
          app: daemonset-example
      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`

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` DaemonSetSpec | The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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 strategy: 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

### RollingUpdateDaemonSet v1 apps

Appears In:

- DaemonSetUpdateStrategy [apps/v1]

Field | Description
--- | ---
`maxSurge` | The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. 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 to a minimum of 1. Default value is 0. 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 a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. This is an alpha field and requires enabling DaemonSetUpdateSurge feature gate.
`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 down to a minimum of one. This cannot be 0 if MaxSurge is 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

## Create

`kubectl` command

    $ echo 'apiVersion: apps/v1
    kind: DaemonSet
    metadata:
      name: daemonset-example
    spec:
      selector:
        matchLabels:
          app: daemonset-example
      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: apps/v1
    kind: DaemonSet
    metadata:
      name: daemonset-example
    spec:
      selector:
        matchLabels:
          app: daemonset-example
      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": "apps/v1",
      "metadata": {
        "name": "daemonset-example",
        "namespace": "default",
        "selfLink": "/apis/apps/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

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

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.

### Response

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

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind DaemonSet

### HTTP Request

`GET /apis/apps/v1/daemonsets`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind DaemonSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

# Deployment v1 apps

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

    apiVersion: apps/v1
    kind: Deployment
    metadata:
      # Unique key of the Deployment instance
      name: deployment-example
    spec:
      # 3 Pods should exist at all times.
      replicas: 3
      selector:
        matchLabels:
          app: nginx
      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.14

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

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/sig-architecture/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/sig-architecture/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 patch strategy: retainKeys | 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 strategy: 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/sig-architecture/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/sig-architecture/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 ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
`maxUnavailable` | The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

## Write Operations

## Create

`kubectl` command

    $ echo 'apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: deployment-example
    spec:
      replicas: 3
      revisionHistoryLimit: 10
      selector:
        matchLabels:
          app: nginx
      template:
        metadata:
          labels:
            app: nginx
        spec:
          containers:
          - name: nginx
            image: nginx:1.14
            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/v1
    kind: Deployment
    metadata:
      name: deployment-example
    spec:
      replicas: 3
      revisionHistoryLimit: 10
      selector:
        matchLabels:
          app: nginx
      template:
        metadata:
          labels:
            app: nginx
        spec:
          containers:
          - name: nginx
            image: nginx:1.14
            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/v1",
      "metadata": {
        "name": "deployment-example",
        "namespace": "default",
        "selfLink": "/apis/apps/v1/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.14",
                "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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### 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.16"}]}}}}'

`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.16"}]}}}}' \
    	'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'

Output

    "deployment-example" patched

Response Body

    {
      "kind": "Deployment",
      "apiVersion": "apps/v1",
      "metadata": {
        "name": "deployment-example",
        "namespace": "default",
        "selfLink": "/apis/apps/v1/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.16",
                "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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Replace

`kubectl` command

    $ echo 'apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: deployment-example
    spec:
      replicas: 3
      revisionHistoryLimit: 10
      selector:
        matchLabels:
          app: nginx
      template:
        metadata:
          labels:
            app: nginx
        spec:
          containers:
          - name: nginx
            image: nginx:1.16
            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/v1
    kind: Deployment
    metadata:
      name: deployment-example
    spec:
      replicas: 3
      revisionHistoryLimit: 10
      selector:
        matchLabels:
          app: nginx
      template:
        metadata:
          labels:
            app: nginx
        spec:
          containers:
          - name: nginx
            image: nginx:1.16
            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/v1",
      "metadata": {
        "name": "deployment-example",
        "namespace": "default",
        "selfLink": "/apis/apps/v1/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.16",
                "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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## 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/v1",
      "metadata": {
        "name": "deployment-example",
        "namespace": "default",
        "selfLink": "/apis/apps/v1/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.14",
                "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/v1",
      "metadata": {
        "name": "deployment-example",
        "namespace": "default",
        "selfLink": "/apis/apps/v1/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.14",
                "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.

### 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.14",
                    "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.14",
                    "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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Deployment

### HTTP Request

`GET /apis/apps/v1/deployments`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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/v1",
    		"metadata": {
    			"name": "deployment-example",
    			"namespace": "default",
    			"selfLink": "/apis/apps/v1/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.14",
    							"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/v1",
    		"metadata": {
    			"name": "deployment-example",
    			"namespace": "default",
    			"selfLink": "/apis/apps/v1/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.14",
    							"ports": [
    								{
    									"containerPort": 80,
    									"protocol": "TCP"
    								}
    							],
    							"resources": {
    							},
    							"terminationMessagePath": "/dev/termination-log",
    							"imagePullPolicy": "IfNotPresent"
    						}
    					],
    					"restartPolicy": "Always",
    					"terminationGracePeriodSeconds": 30,
    					"dnsPolicy": "ClusterFirst",
    					"securityContext": {
    					}
    				}
    			},
    			"strategy": {
    				"type": "RollingUpdate",
    				"rollingUpdate": {
    					"maxUnavailable": 1,
    					"maxSurge": 1
    				}
    			}
    		},
    		"status": {
    			"observedGeneration": 2,
    			"replicas": 3,
    			"updatedReplicas": 3,
    			"availableReplicas": 3
    		}
    	}
    }

watch changes to an object of kind Deployment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Misc Operations

## Read Scale

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch Scale

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

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

Group | Version | Kind
--- | --- | ---
`batch` | `v1` | `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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` JobSpec | Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
`status` JobStatus | Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

### JobSpec v1 batch

Appears In:

- Job [batch/v1]
- JobTemplateSpec [batch/v1]
- JobTemplateSpec [batch/v1beta1]

Field | Description
--- | ---
`activeDeadlineSeconds` integer | Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.
`backoffLimit` integer | Specifies the number of retries before marking this job failed. Defaults to 6
`completionMode` string | CompletionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. This field is alpha-level and is only honored by servers that enable the IndexedJob feature gate. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, the controller skips updates for the Job.
`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
`suspend` boolean | Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. This is an alpha field and requires the SuspendJob feature gate to be enabled; otherwise this field may not be set to true. Defaults to false.
`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/
`ttlSecondsAfterFinished` integer | ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.

### JobStatus v1 batch

Appears In:

- Job [batch/v1]

Field | Description
--- | ---
`active` integer | The number of actively running pods.
`completedIndexes` string | CompletedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7".
`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. The completion time is only set when the job finishes successfully.
`conditions` JobCondition array patch strategy: merge patch merge key: type | The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true. 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 controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## 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.

### 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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Job

### HTTP Request

`GET /apis/batch/v1/jobs`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### 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"]

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

Warning:

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

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` PodSpec | Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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 strategy: merge patch merge key: name | List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
`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'.
`enableServiceLinks` boolean | EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.
`ephemeralContainers` EphemeralContainer array patch strategy: merge patch merge key: name | List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.
`hostAliases` HostAlias array patch strategy: merge patch merge key: ip | HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
`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 strategy: merge patch merge key: name | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
`initContainers` Container array patch strategy: merge patch merge key: name | List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup 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/
`overhead` object | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.
`preemptionPolicy` string | PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
`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.
`readinessGates` PodReadinessGate array | If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md
`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
`runtimeClassName` string | RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.
`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/
`setHostnameAsFQDN` boolean | If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
`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.
`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 stop immediately via the kill signal (no opportunity to shut down). 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.
`topologySpreadConstraints` TopologySpreadConstraint array patch strategy: merge patch merge key: topologyKey | TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
`volumes` Volume array patch strategy: merge,retainKeys patch merge key: name | List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

### PodStatus v1 core

Appears In:

- Pod [core/v1]

Field | Description
--- | ---
`conditions` PodCondition array patch strategy: merge patch merge key: type | Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
`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
`ephemeralContainerStatuses` ContainerStatus array | Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature.
`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 | The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values: Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
`podIP` string | IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
`podIPs` PodIP array patch strategy: merge patch merge key: ip | podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet.
`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/sig-architecture/api-conventions.md#resources
`items` Pod array | List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Create Eviction

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
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

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

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

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

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

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

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Pod

### HTTP Request

`GET /api/v1/pods`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Pod. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/pods`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## EphemeralContainers Operations

## Patch EphemeralContainers

partially update ephemeralcontainers of the specified Pod

### HTTP Request

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

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 EphemeralContainers | OK

## Read EphemeralContainers

read ephemeralcontainers of the specified Pod

### HTTP Request

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

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the EphemeralContainers
`namespace` | 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 EphemeralContainers | OK

## Replace EphemeralContainers

replace ephemeralcontainers of the specified Pod

### HTTP Request

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

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` EphemeralContainers |

### Response

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

## Proxy Operations

## Create Connect Portforward

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

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

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

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

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

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

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

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

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

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

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

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

## Read Log

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.
`insecureSkipTLSVerifyBackend` | insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).
`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: apps/v1
    kind: ReplicaSet
    metadata:
      # Unique key of the ReplicaSet instance
      name: replicaset-example
    spec:
      # 3 Pods should exist at all times.
      replicas: 3
      selector:
        matchLabels:
          app: nginx
      template:
        metadata:
          labels:
            app: nginx
        spec:
          containers:
          # Run the nginx image
          - name: nginx
            image: nginx:1.14

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

Warning:

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

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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/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 strategy: 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

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

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind ReplicaSet

### HTTP Request

`GET /apis/apps/v1/replicasets`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Misc Operations

## Read Scale

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch Scale

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### 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.14

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

Warning:

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

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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/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 strategy: 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

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

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind ReplicationController

### HTTP Request

`GET /api/v1/replicationcontrollers`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ReplicationController. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/replicationcontrollers`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Misc Operations

## Read Scale

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch Scale

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

# StatefulSet v1 apps

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

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/sig-architecture/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/sig-architecture/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 strategy: 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta |

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

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

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind StatefulSet

### HTTP Request

`GET /apis/apps/v1/statefulsets`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind StatefulSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Misc Operations

## Read Scale

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch Scale

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

# SERVICE APIs

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

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Endpoints |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Endpoints | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Endpoints |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 Endpoints | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Endpoints

### HTTP Request

`GET /api/v1/endpoints`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Endpoints. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/endpoints`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# EndpointSlice v1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1` | `EndpointSlice`

Other API versions of this object exist: v1beta1
Appears In:

- EndpointSliceList [discovery/v1]

Field | Description
--- | ---
`addressType` string | addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name.
`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/sig-architecture/api-conventions.md#resources
`endpoints` Endpoint array | endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata.
`ports` EndpointPort array | ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports.

### EndpointSliceList v1 discovery

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/sig-architecture/api-conventions.md#resources
`items` EndpointSlice array | List of endpoint slices
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata.

## Write Operations

## Create

create an EndpointSlice

### HTTP Request

`POST /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices`

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` EndpointSlice |

### Response

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

## Patch

partially update the specified EndpointSlice

### HTTP Request

`PATCH /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 EndpointSlice | OK

## Replace

replace the specified EndpointSlice

### HTTP Request

`PUT /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` EndpointSlice |

### Response

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

## Delete

delete an EndpointSlice

### HTTP Request

`DELETE /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}`

### Path Parameters

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

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of EndpointSlice

### HTTP Request

`DELETE /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified EndpointSlice

### HTTP Request

`GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the EndpointSlice
`namespace` | 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 EndpointSlice | OK

## List

list or watch objects of kind EndpointSlice

### HTTP Request

`GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices`

### 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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 EndpointSliceList | OK

## List All Namespaces

list or watch objects of kind EndpointSlice

### HTTP Request

`GET /apis/discovery.k8s.io/v1/endpointslices`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 EndpointSliceList | OK

## Watch

watch changes to an object of kind EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/discovery.k8s.io/v1/watch/namespaces/{namespace}/endpointslices/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/discovery.k8s.io/v1/watch/namespaces/{namespace}/endpointslices`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/discovery.k8s.io/v1/watch/endpointslices`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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 v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `Ingress`

Other API versions of this object exist: v1beta1 v1beta1
Appears In:

- IngressList [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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` IngressSpec | Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#spec-and-status

### IngressSpec v1 networking

Appears In:

- Ingress [networking/v1]

Field | Description
--- | ---
`defaultBackend` IngressBackend | DefaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller.
`ingressClassName` string | IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.
`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 v1 networking

Appears In:

- Ingress [networking/v1]

Field | Description
--- | ---
`loadBalancer` LoadBalancerStatus | LoadBalancer contains the current status of the load-balancer.

### IngressList 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create an Ingress

### HTTP Request

`POST /apis/networking.k8s.io/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

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

## Patch

partially update the specified Ingress

### HTTP Request

`PATCH /apis/networking.k8s.io/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Ingress | OK

## Replace

replace the specified Ingress

### HTTP Request

`PUT /apis/networking.k8s.io/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

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

## Delete

delete an Ingress

### HTTP Request

`DELETE /apis/networking.k8s.io/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of Ingress

### HTTP Request

`DELETE /apis/networking.k8s.io/v1/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified Ingress

### HTTP Request

`GET /apis/networking.k8s.io/v1/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.

### Response

Code | Description
--- | ---
200 Ingress | OK

## List

list or watch objects of kind Ingress

### HTTP Request

`GET /apis/networking.k8s.io/v1/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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Ingress

### HTTP Request

`GET /apis/networking.k8s.io/v1/ingresses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/networking.k8s.io/v1/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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/networking.k8s.io/v1/watch/ingresses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified Ingress

### HTTP Request

`PATCH /apis/networking.k8s.io/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Ingress | OK

## Read Status

read status of the specified Ingress

### HTTP Request

`GET /apis/networking.k8s.io/v1/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

replace status of the specified Ingress

### HTTP Request

`PUT /apis/networking.k8s.io/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

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

# IngressClass v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `IngressClass`

Other API versions of this object exist: v1beta1
Appears In:

- IngressClassList [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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` IngressClassSpec | Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

### IngressClassSpec v1 networking

Appears In:

- IngressClass [networking/v1]

Field | Description
--- | ---
`controller` string | Controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable.
`parameters` IngressClassParametersReference | Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.

### IngressClassList 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/sig-architecture/api-conventions.md#resources
`items` IngressClass array | Items is the list of IngressClasses.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata.

## Write Operations

## Create

create an IngressClass

### HTTP Request

`POST /apis/networking.k8s.io/v1/ingressclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` IngressClass |

### Response

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

## Patch

partially update the specified IngressClass

### HTTP Request

`PATCH /apis/networking.k8s.io/v1/ingressclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the IngressClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 IngressClass | OK

## Replace

replace the specified IngressClass

### HTTP Request

`PUT /apis/networking.k8s.io/v1/ingressclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the IngressClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` IngressClass |

### Response

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

## Delete

delete an IngressClass

### HTTP Request

`DELETE /apis/networking.k8s.io/v1/ingressclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the IngressClass

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of IngressClass

### HTTP Request

`DELETE /apis/networking.k8s.io/v1/ingressclasses`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified IngressClass

### HTTP Request

`GET /apis/networking.k8s.io/v1/ingressclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the IngressClass

### Query Parameters

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

### Response

Code | Description
--- | ---
200 IngressClass | OK

## List

list or watch objects of kind IngressClass

### HTTP Request

`GET /apis/networking.k8s.io/v1/ingressclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 IngressClassList | OK

## Watch

watch changes to an object of kind IngressClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/networking.k8s.io/v1/watch/ingressclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the IngressClass

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of IngressClass. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/networking.k8s.io/v1/watch/ingressclasses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# 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

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

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` ServiceSpec | Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#spec-and-status

### ServiceSpec v1 core

Appears In:

- Service [core/v1]

Field | Description
--- | ---
`allocateLoadBalancerNodePorts` boolean | allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. allocateLoadBalancerNodePorts may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is alpha-level and is only honored by servers that enable the ServiceLBNodePortControl feature.
`clusterIP` string | clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
`clusterIPs` string array | ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. Unless the "IPv6DualStack" feature gate is enabled, this field is limited to one value, which must be the same as the clusterIP field. If the feature gate is enabled, this field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. 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 discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase 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. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type).
`internalTrafficPolicy` string | InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
`ipFamilies` string array | IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service, and is gated by the "IPv6DualStack" feature gate. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
`ipFamilyPolicy` string | IPFamilyPolicy represents the dual-stack-ness requested or required by this Service, and is gated by the "IPv6DualStack" feature gate. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName.
`loadBalancerClass` string | loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
`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 strategy: merge patch merge key: port | The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
`publishNotReadyAddresses` boolean | publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior.
`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.
`topologyKeys` string array | topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. This field is alpha-level and is only honored by servers that enable the ServiceTopology feature. This field is deprecated and will be removed in a future version.
`type` string | type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "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 or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types

### ServiceStatus v1 core

Appears In:

- Service [core/v1]

Field | Description
--- | ---
`conditions` Condition array patch strategy: merge patch merge key: type | Current service state
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Read Operations

## 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.

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Service

### HTTP Request

`GET /api/v1/services`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/services`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Service | OK

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Service |

### Response

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

## Proxy Operations

## Create Connect Proxy

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

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

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

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

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

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

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

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

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

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

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/sig-architecture/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.
`immutable` boolean | Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ConfigMap |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ConfigMap | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ConfigMap |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 ConfigMap | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind ConfigMap

### HTTP Request

`GET /api/v1/configmaps`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ConfigMap. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/configmaps`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# CSIDriver v1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1` | `CSIDriver`

Other API versions of this object exist: v1beta1
Appears In:

- CSIDriverList [storage/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` CSIDriverSpec | Specification of the CSI Driver.

### CSIDriverSpec v1 storage

Appears In:

- CSIDriver [storage/v1]

Field | Description
--- | ---
`attachRequired` boolean | attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. This field is immutable.
`fsGroupPolicy` string | Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate. This field is immutable.
`podInfoOnMount` boolean | If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false" "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. This field is immutable.
`requiresRepublish` boolean | RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false. Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.
`storageCapacity` boolean | If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. This field is immutable. This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false.
`tokenRequests` TokenRequest array | TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { "<audience>": { "token": <token>, "expirationTimestamp": <expiration timestamp in RFC3339>, }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.
`volumeLifecycleModes` string array | volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta. This field is immutable.

### CSIDriverList 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/sig-architecture/api-conventions.md#resources
`items` CSIDriver array | items is the list of CSIDriver
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a CSIDriver

### HTTP Request

`POST /apis/storage.k8s.io/v1/csidrivers`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSIDriver |

### Response

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

## Patch

partially update the specified CSIDriver

### HTTP Request

`PATCH /apis/storage.k8s.io/v1/csidrivers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIDriver

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CSIDriver | OK

## Replace

replace the specified CSIDriver

### HTTP Request

`PUT /apis/storage.k8s.io/v1/csidrivers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIDriver

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSIDriver |

### Response

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

## Delete

delete a CSIDriver

### HTTP Request

`DELETE /apis/storage.k8s.io/v1/csidrivers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIDriver

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CSIDriver | OK
202 CSIDriver | Accepted

## Delete Collection

delete collection of CSIDriver

### HTTP Request

`DELETE /apis/storage.k8s.io/v1/csidrivers`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified CSIDriver

### HTTP Request

`GET /apis/storage.k8s.io/v1/csidrivers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIDriver

### Query Parameters

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

### Response

Code | Description
--- | ---
200 CSIDriver | OK

## List

list or watch objects of kind CSIDriver

### HTTP Request

`GET /apis/storage.k8s.io/v1/csidrivers`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CSIDriverList | OK

## Watch

watch changes to an object of kind CSIDriver. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1/watch/csidrivers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIDriver

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CSIDriver. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1/watch/csidrivers`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# CSINode v1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1` | `CSINode`

Other API versions of this object exist: v1beta1
Appears In:

- CSINodeList [storage/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | metadata.name must be the Kubernetes node name.
`spec` CSINodeSpec | spec is the specification of CSINode

### CSINodeSpec v1 storage

Appears In:

- CSINode [storage/v1]

Field | Description
--- | ---
`drivers` CSINodeDriver array patch strategy: merge patch merge key: name | drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty.

### CSINodeList 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/sig-architecture/api-conventions.md#resources
`items` CSINode array | items is the list of CSINode
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a CSINode

### HTTP Request

`POST /apis/storage.k8s.io/v1/csinodes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSINode |

### Response

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

## Patch

partially update the specified CSINode

### HTTP Request

`PATCH /apis/storage.k8s.io/v1/csinodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSINode

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CSINode | OK

## Replace

replace the specified CSINode

### HTTP Request

`PUT /apis/storage.k8s.io/v1/csinodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSINode

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSINode |

### Response

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

## Delete

delete a CSINode

### HTTP Request

`DELETE /apis/storage.k8s.io/v1/csinodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSINode

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CSINode | OK
202 CSINode | Accepted

## Delete Collection

delete collection of CSINode

### HTTP Request

`DELETE /apis/storage.k8s.io/v1/csinodes`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified CSINode

### HTTP Request

`GET /apis/storage.k8s.io/v1/csinodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSINode

### Query Parameters

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

### Response

Code | Description
--- | ---
200 CSINode | OK

## List

list or watch objects of kind CSINode

### HTTP Request

`GET /apis/storage.k8s.io/v1/csinodes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CSINodeList | OK

## Watch

watch changes to an object of kind CSINode. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1/watch/csinodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSINode

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CSINode. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1/watch/csinodes`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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`

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/sig-architecture/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
`immutable` boolean | Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`stringData` object | stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Secret |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Secret | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Secret |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 Secret | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Secret

### HTTP Request

`GET /api/v1/secrets`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Secret. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/secrets`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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.
Appears In:

- PersistentVolumeClaimList [core/v1]
- StatefulSetSpec [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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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]
- PersistentVolumeClaimTemplate [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
`dataSource` TypedLocalObjectReference | This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.
`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.
`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 strategy: merge patch merge key: type | Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolumeClaim |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolumeClaim |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK
202 PersistentVolumeClaim | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind PersistentVolumeClaim

### HTTP Request

`GET /api/v1/persistentvolumeclaims`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/persistentvolumeclaims`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PersistentVolumeClaim | OK

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### 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
Appears In:

- StorageClassList [storage/v1]

Field | Description
--- | ---
`allowVolumeExpansion` boolean | AllowVolumeExpansion shows whether the storage class allow volume expand
`allowedTopologies` TopologySelectorTerm array | Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageClass |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 StorageClass | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageClass |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 StorageClass | OK
202 StorageClass | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 StorageClass | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1/watch/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1/watch/storageclasses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# CSIStorageCapacity v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `CSIStorageCapacity`

Other API versions of this object exist: v1alpha1
Appears In:

- CSIStorageCapacityList [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/sig-architecture/api-conventions.md#resources
`capacity` Quantity | Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity.
`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/sig-architecture/api-conventions.md#types-kinds
`maximumVolumeSize` Quantity | MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.
`metadata` ObjectMeta | Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name. Objects are namespaced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`nodeTopology` LabelSelector | NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.
`storageClassName` string | The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.

### CSIStorageCapacityList 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/sig-architecture/api-conventions.md#resources
`items` CSIStorageCapacity array | Items is the list of CSIStorageCapacity 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a CSIStorageCapacity

### HTTP Request

`POST /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities`

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSIStorageCapacity |

### Response

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

## Patch

partially update the specified CSIStorageCapacity

### HTTP Request

`PATCH /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CSIStorageCapacity | OK

## Replace

replace the specified CSIStorageCapacity

### HTTP Request

`PUT /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSIStorageCapacity |

### Response

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

## Delete

delete a CSIStorageCapacity

### HTTP Request

`DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}`

### Path Parameters

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

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of CSIStorageCapacity

### HTTP Request

`DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified CSIStorageCapacity

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIStorageCapacity
`namespace` | 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 CSIStorageCapacity | OK

## List

list or watch objects of kind CSIStorageCapacity

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities`

### 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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CSIStorageCapacityList | OK

## List All Namespaces

list or watch objects of kind CSIStorageCapacity

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/csistoragecapacities`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CSIStorageCapacityList | OK

## Watch

watch changes to an object of kind CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/namespaces/{namespace}/csistoragecapacities/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/namespaces/{namespace}/csistoragecapacities`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/csistoragecapacities`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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`

Appears In:

- 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://examples.k8s.io/mysql-cinder-pd/README.md
`configMap` ConfigMapVolumeSource | ConfigMap represents a configMap that should populate this volume
`csi` CSIVolumeSource | CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
`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
`ephemeral` EphemeralVolumeSource | Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.
`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. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
`glusterfs` GlusterfsVolumeSource | Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/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 v1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1` | `VolumeAttachment`

Other API versions of this object exist: v1beta1 v1alpha1
Appears In:

- VolumeAttachmentList [storage/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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 v1 storage

Appears In:

- VolumeAttachment [storage/v1]

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 v1 storage

Appears In:

- VolumeAttachment [storage/v1]

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 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a VolumeAttachment

### HTTP Request

`POST /apis/storage.k8s.io/v1/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

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

## Patch

partially update the specified VolumeAttachment

### HTTP Request

`PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## Replace

replace the specified VolumeAttachment

### HTTP Request

`PUT /apis/storage.k8s.io/v1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

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

## Delete

delete a VolumeAttachment

### HTTP Request

`DELETE /apis/storage.k8s.io/v1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK
202 VolumeAttachment | Accepted

## Delete Collection

delete collection of VolumeAttachment

### HTTP Request

`DELETE /apis/storage.k8s.io/v1/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

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

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## List

list or watch objects of kind VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1/watch/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1/watch/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified VolumeAttachment

### HTTP Request

`PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## Read Status

read status of the specified VolumeAttachment

### HTTP Request

`GET /apis/storage.k8s.io/v1/volumeattachments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

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

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## Replace Status

replace status of the specified VolumeAttachment

### HTTP Request

`PUT /apis/storage.k8s.io/v1/volumeattachments/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

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

# 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.
- Event for notification of resource lifecycle events in the cluster.

# ControllerRevision v1 apps

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

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ControllerRevision |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ControllerRevision | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ControllerRevision |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 ControllerRevision | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind ControllerRevision

### HTTP Request

`GET /apis/apps/v1/controllerrevisions`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/apps/v1/watch/controllerrevisions`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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 v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `CustomResourceDefinition`

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceDefinitionList [apiextensions/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/sig-architecture/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/sig-architecture/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 v1 apiextensions

Appears In:

- CustomResourceDefinition [apiextensions/v1]

Field | Description
--- | ---
`conversion` CustomResourceConversion | conversion defines conversion settings for the CRD.
`group` string | group is the API group of the defined custom resource. The custom resources are served under `/apis/<group>/...`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`).
`names` CustomResourceDefinitionNames | names specify the resource and kind names for the custom resource.
`preserveUnknownFields` boolean | preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
`scope` string | scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`.
`versions` CustomResourceDefinitionVersion array | versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.

### CustomResourceDefinitionStatus v1 apiextensions

Appears In:

- CustomResourceDefinition [apiextensions/v1]

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
`storedVersions` string array | storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from `spec.versions` while they exist in this list.

### CustomResourceDefinitionList v1 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/sig-architecture/api-conventions.md#resources
`items` CustomResourceDefinition array | items list individual CustomResourceDefinition 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta |

## Write Operations

## Create

create a CustomResourceDefinition

### HTTP Request

`POST /apis/apiextensions.k8s.io/v1/customresourcedefinitions`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CustomResourceDefinition |

### Response

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

## Patch

partially update the specified CustomResourceDefinition

### HTTP Request

`PATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK

## Replace

replace the specified CustomResourceDefinition

### HTTP Request

`PUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CustomResourceDefinition |

### Response

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

## Delete

delete a CustomResourceDefinition

### HTTP Request

`DELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of CustomResourceDefinition

### HTTP Request

`DELETE /apis/apiextensions.k8s.io/v1/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified CustomResourceDefinition

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

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

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK

## List

list or watch objects of kind CustomResourceDefinition

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified CustomResourceDefinition

### HTTP Request

`PATCH /apis/apiextensions.k8s.io/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK

## Read Status

read status of the specified CustomResourceDefinition

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1/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.

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK

## Replace Status

replace status of the specified CustomResourceDefinition

### HTTP Request

`PUT /apis/apiextensions.k8s.io/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CustomResourceDefinition |

### Response

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

# Event v1 events.k8s.io

Group | Version | Kind
--- | --- | ---
`events.k8s.io` | `v1` | `Event`

Other API versions of this object exist: v1beta1
Appears In:

- EventList [events/v1]

Field | Description
--- | ---
`action` string | action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters.
`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/sig-architecture/api-conventions.md#resources
`deprecatedCount` integer | deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.
`deprecatedFirstTimestamp` Time | deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
`deprecatedLastTimestamp` Time | deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
`deprecatedSource` EventSource | deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.
`eventTime` MicroTime | eventTime is the time when this Event was first observed. It is required.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`note` string | note is 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 | reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters.
`regarding` ObjectReference | regarding contains 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 | related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.
`reportingController` string | reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events.
`reportingInstance` string | reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters.
`series` EventSeries | series is data about the Event series this event represents or nil if it's a singleton Event.
`type` string | type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events.

### EventList v1 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create an Event

### HTTP Request

`POST /apis/events.k8s.io/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Event |

### Response

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

## Patch

partially update the specified Event

### HTTP Request

`PATCH /apis/events.k8s.io/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Event | OK

## Replace

replace the specified Event

### HTTP Request

`PUT /apis/events.k8s.io/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Event |

### Response

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

## Delete

delete an Event

### HTTP Request

`DELETE /apis/events.k8s.io/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of Event

### HTTP Request

`DELETE /apis/events.k8s.io/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified Event

### HTTP Request

`GET /apis/events.k8s.io/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.

### Response

Code | Description
--- | ---
200 Event | OK

## List

list or watch objects of kind Event

### HTTP Request

`GET /apis/events.k8s.io/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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Event

### HTTP Request

`GET /apis/events.k8s.io/v1/events`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/events.k8s.io/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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/events.k8s.io/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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/events.k8s.io/v1/watch/events`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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`

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` LimitRangeSpec | Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#resources
`items` LimitRange array | Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` LimitRange |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 LimitRange | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` LimitRange |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 LimitRange | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind LimitRange

### HTTP Request

`GET /api/v1/limitranges`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind LimitRange. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/limitranges`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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: v2beta2 v2beta1
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` HorizontalPodAutoscalerSpec | behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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 | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v1/horizontalpodautoscalers`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/autoscaling/v1/watch/horizontalpodautoscalers`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

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

# MutatingWebhookConfiguration v1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1` | `MutatingWebhookConfiguration`

Other API versions of this object exist: v1beta1
Appears In:

- MutatingWebhookConfigurationList [admissionregistration/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
`webhooks` MutatingWebhook array patch strategy: merge patch merge key: name | Webhooks is a list of webhooks and the affected resources and operations.

### MutatingWebhookConfigurationList v1 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

create a MutatingWebhookConfiguration

### HTTP Request

`POST /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` MutatingWebhookConfiguration |

### Response

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

## Patch

partially update the specified MutatingWebhookConfiguration

### HTTP Request

`PATCH /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 MutatingWebhookConfiguration | OK

## Replace

replace the specified MutatingWebhookConfiguration

### HTTP Request

`PUT /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` MutatingWebhookConfiguration |

### Response

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

## Delete

delete a MutatingWebhookConfiguration

### HTTP Request

`DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of MutatingWebhookConfiguration

### HTTP Request

`DELETE /apis/admissionregistration.k8s.io/v1/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified MutatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

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

### Response

Code | Description
--- | ---
200 MutatingWebhookConfiguration | OK

## List

list or watch objects of kind MutatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1/watch/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1/watch/mutatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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 v1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1` | `ValidatingWebhookConfiguration`

Other API versions of this object exist: v1beta1
Appears In:

- ValidatingWebhookConfigurationList [admissionregistration/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
`webhooks` ValidatingWebhook array patch strategy: merge patch merge key: name | Webhooks is a list of webhooks and the affected resources and operations.

### ValidatingWebhookConfigurationList v1 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

create a ValidatingWebhookConfiguration

### HTTP Request

`POST /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ValidatingWebhookConfiguration |

### Response

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

## Patch

partially update the specified ValidatingWebhookConfiguration

### HTTP Request

`PATCH /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ValidatingWebhookConfiguration | OK

## Replace

replace the specified ValidatingWebhookConfiguration

### HTTP Request

`PUT /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ValidatingWebhookConfiguration |

### Response

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

## Delete

delete a ValidatingWebhookConfiguration

### HTTP Request

`DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of ValidatingWebhookConfiguration

### HTTP Request

`DELETE /apis/admissionregistration.k8s.io/v1/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified ValidatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

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

### Response

Code | Description
--- | ---
200 ValidatingWebhookConfiguration | OK

## List

list or watch objects of kind ValidatingWebhookConfiguration

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1/watch/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1/watch/validatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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`

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#spec-and-status

### PodTemplateSpec v1 core

Appears In:

- DaemonSetSpec [apps/v1]
- DeploymentSpec [apps/v1]
- JobSpec [batch/v1]
- PodTemplate [core/v1]
- ReplicaSetSpec [apps/v1]
- ReplicationControllerSpec [core/v1]
- StatefulSetSpec [apps/v1]

Field | Description
--- | ---
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` PodSpec | Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PodTemplate |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PodTemplate | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PodTemplate |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PodTemplate | OK
202 PodTemplate | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 PodTemplate | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind PodTemplate

### HTTP Request

`GET /api/v1/podtemplates`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind PodTemplate. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/podtemplates`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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 v1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1` | `PodDisruptionBudget`

Other API versions of this object exist: v1beta1
Appears In:

- PodDisruptionBudgetList [policy/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` PodDisruptionBudgetSpec | Specification of the desired behavior of the PodDisruptionBudget.
`status` PodDisruptionBudgetStatus | Most recently observed status of the PodDisruptionBudget.

### PodDisruptionBudgetSpec v1 policy

Appears In:

- PodDisruptionBudget [policy/v1]

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 patch strategy: replace | Label query over pods whose evictions are managed by the disruption budget. A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace.

### PodDisruptionBudgetStatus v1 policy

Appears In:

- PodDisruptionBudget [policy/v1]

Field | Description
--- | ---
`conditions` Condition array patch strategy: merge patch merge key: type | Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the future): - SyncFailed: The controller encountered an error and wasn't able to compute the number of allowed disruptions. Therefore no disruptions are allowed and the status of the condition will be False. - InsufficientPods: The number of pods are either at or below the number required by the PodDisruptionBudget. No disruptions are allowed and the status of the condition will be False. - SufficientPods: There are more pods than required by the PodDisruptionBudget. The condition will be True, and the number of allowed disruptions are provided by the disruptionsAllowed property.
`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. DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.

### PodDisruptionBudgetList v1 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/sig-architecture/api-conventions.md#resources
`items` PodDisruptionBudget array | Items is a list of PodDisruptionBudgets
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a PodDisruptionBudget

### HTTP Request

`POST /apis/policy/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PodDisruptionBudget |

### Response

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

## Patch

partially update the specified PodDisruptionBudget

### HTTP Request

`PATCH /apis/policy/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK

## Replace

replace the specified PodDisruptionBudget

### HTTP Request

`PUT /apis/policy/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PodDisruptionBudget |

### Response

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

## Delete

delete a PodDisruptionBudget

### HTTP Request

`DELETE /apis/policy/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of PodDisruptionBudget

### HTTP Request

`DELETE /apis/policy/v1/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1/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.

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK

## List

list or watch objects of kind PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1/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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1/poddisruptionbudgets`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/policy/v1/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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/policy/v1/watch/namespaces/{namespace}/poddisruptionbudgets`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/policy/v1/watch/poddisruptionbudgets`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified PodDisruptionBudget

### HTTP Request

`PATCH /apis/policy/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK

## Read Status

read status of the specified PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1/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

replace status of the specified PodDisruptionBudget

### HTTP Request

`PUT /apis/policy/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PodDisruptionBudget |

### Response

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

# PriorityClass v1 scheduling.k8s.io

Group | Version | Kind
--- | --- | ---
`scheduling.k8s.io` | `v1` | `PriorityClass`

Other API versions of this object exist: v1beta1 v1alpha1
Appears In:

- PriorityClassList [scheduling/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`preemptionPolicy` string | PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
`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 v1 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a PriorityClass

### HTTP Request

`POST /apis/scheduling.k8s.io/v1/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityClass |

### Response

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

## Patch

partially update the specified PriorityClass

### HTTP Request

`PATCH /apis/scheduling.k8s.io/v1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PriorityClass | OK

## Replace

replace the specified PriorityClass

### HTTP Request

`PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityClass |

### Response

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

## Delete

delete a PriorityClass

### HTTP Request

`DELETE /apis/scheduling.k8s.io/v1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of PriorityClass

### HTTP Request

`DELETE /apis/scheduling.k8s.io/v1/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified PriorityClass

### HTTP Request

`GET /apis/scheduling.k8s.io/v1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

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

### Response

Code | Description
--- | ---
200 PriorityClass | OK

## List

list or watch objects of kind PriorityClass

### HTTP Request

`GET /apis/scheduling.k8s.io/v1/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/scheduling.k8s.io/v1/watch/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `PodSecurityPolicy`

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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.
`allowedCSIDrivers` AllowedCSIDriver array | AllowedCSIDrivers is an allowlist of inline CSI drivers that must be explicitly set to be embedded within a pod spec. An empty value indicates that any CSI driver can be used for inline ephemeral volumes. This is a beta field, and is only honored if the API server enables the CSIInlineVolume feature gate.
`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 an allowlist of 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 | allowedHostPaths is an allowlist of host paths. Empty indicates that all host paths may be used.
`allowedProcMountTypes` string array | AllowedProcMountTypes is an allowlist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled.
`allowedUnsafeSysctls` string array | allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to allowlist all allowed unsafe sysctls explicitly to avoid rejection. Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc.
`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.
`forbiddenSysctls` string array | forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc.
`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.
`runAsGroup` RunAsGroupStrategyOptions | RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. If this field is omitted, the pod's RunAsGroup can take any value. This field requires the RunAsGroup feature gate to be enabled.
`runAsUser` RunAsUserStrategyOptions | runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.
`runtimeClass` RuntimeClassStrategyOptions | runtimeClass is the strategy that will dictate the allowable RuntimeClasses for a pod. If this field is omitted, the pod's runtimeClassName field is unrestricted. Enforcement of this field depends on the RuntimeClass feature gate being enabled.
`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 an allowlist of volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '\*'.

### 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a PodSecurityPolicy

### HTTP Request

`POST /apis/policy/v1beta1/podsecuritypolicies`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PodSecurityPolicy |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PodSecurityPolicy | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PodSecurityPolicy |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PodSecurityPolicy | OK
202 PodSecurityPolicy | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 PodSecurityPolicy | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/policy/v1beta1/watch/podsecuritypolicies/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PodSecurityPolicy

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/policy/v1beta1/watch/podsecuritypolicies`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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
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/sig-architecture/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/sig-architecture/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. If unspecified, system trust roots on the apiserver are used.
`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). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.

### APIServiceStatus v1 apiregistration

Appears In:

- APIService [apiregistration/v1]

Field | Description
--- | ---
`conditions` APIServiceCondition array patch strategy: 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta |

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 APIService | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 APIService | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1/watch/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1/watch/apiservices`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified APIService

### HTTP Request

`PATCH /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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 APIService | OK

## Read Status

read status of the specified APIService

### HTTP Request

`GET /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.

### Response

Code | Description
--- | ---
200 APIService | OK

## Replace Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

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

# Binding v1 core

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

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`target` ObjectReference | The target object that you want to bind to the standard object.

## Write Operations

## Create

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
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` Binding |

### Response

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

# CertificateSigningRequest v1 certificates.k8s.io

Group | Version | Kind
--- | --- | ---
`certificates.k8s.io` | `v1` | `CertificateSigningRequest`

Other API versions of this object exist: v1beta1
Appears In:

- CertificateSigningRequestList [certificates/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta |
`spec` CertificateSigningRequestSpec | spec contains the certificate request, and is immutable after creation. Only the request, signerName, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users.
`status` CertificateSigningRequestStatus | status contains information about whether the request is approved or denied, and the certificate issued by the signer, or the failure condition indicating signer failure.

### CertificateSigningRequestSpec v1 certificates

Appears In:

- CertificateSigningRequest [certificates/v1]

Field | Description
--- | ---
`extra` object | extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
`groups` string array | groups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
`request` string | request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded.
`signerName` string | signerName indicates the requested signer, and is a qualified name. List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector. Well-known Kubernetes signers are: 1. "kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver. Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager. 2. "kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver. Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. 3. "kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely. Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers Custom signerNames can also be specified. The signer defines: 1. Trust distribution: how trust (CA bundles) are distributed. 2. Permitted subjects: and behavior when a disallowed subject is requested. 3. Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested. 4. Required, permitted, or forbidden key usages / extended key usages. 5. Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin. 6. Whether or not requests for CA certificates are allowed.
`uid` string | uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
`usages` string array | usages specifies a set of key usages requested in the issued certificate. Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth". Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth". Valid values are: "signing", "digital signature", "content commitment", "key encipherment", "key agreement", "data encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "email protection", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc"
`username` string | username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

### CertificateSigningRequestStatus v1 certificates

Appears In:

- CertificateSigningRequest [certificates/v1]

Field | Description
--- | ---
`certificate` string | certificate is populated with an issued certificate by the signer after an Approved condition is present. This field is set via the /status subresource. Once populated, this field is immutable. If the certificate signing request is denied, a condition of type "Denied" is added and this field remains empty. If the signer cannot issue the certificate, a condition of type "Failed" is added and this field remains empty. Validation requirements: 1. certificate must contain one or more PEM blocks. 2. All PEM blocks must have the "CERTIFICATE" label, contain no headers, and the encoded data must be a BER-encoded ASN.1 Certificate structure as described in section 4 of RFC5280. 3. Non-PEM content may appear before or after the "CERTIFICATE" PEM blocks and is unvalidated, to allow for explanatory text as described in section 5.2 of RFC7468. If more than one PEM block is present, and the definition of the requested spec.signerName does not indicate otherwise, the first block is the issued certificate, and subsequent blocks should be treated as intermediate certificates and presented in TLS handshakes. The certificate is encoded in PEM format. When serialized as JSON or YAML, the data is additionally base64-encoded, so it consists of: base64( -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- )
`conditions` CertificateSigningRequestCondition array | conditions applied to the request. Known conditions are "Approved", "Denied", and "Failed".

### CertificateSigningRequestList v1 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/sig-architecture/api-conventions.md#resources
`items` CertificateSigningRequest array | items is a collection of CertificateSigningRequest 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta |

## Write Operations

## Create

create a CertificateSigningRequest

### HTTP Request

`POST /apis/certificates.k8s.io/v1/certificatesigningrequests`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CertificateSigningRequest |

### Response

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

## Patch

partially update the specified CertificateSigningRequest

### HTTP Request

`PATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK

## Replace

replace the specified CertificateSigningRequest

### HTTP Request

`PUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CertificateSigningRequest |

### Response

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

## Delete

delete a CertificateSigningRequest

### HTTP Request

`DELETE /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of CertificateSigningRequest

### HTTP Request

`DELETE /apis/certificates.k8s.io/v1/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified CertificateSigningRequest

### HTTP Request

`GET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

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

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK

## List

list or watch objects of kind CertificateSigningRequest

### HTTP Request

`GET /apis/certificates.k8s.io/v1/certificatesigningrequests`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/certificates.k8s.io/v1/watch/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/certificates.k8s.io/v1/watch/certificatesigningrequests`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified CertificateSigningRequest

### HTTP Request

`PATCH /apis/certificates.k8s.io/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK

## Read Status

read status of the specified CertificateSigningRequest

### HTTP Request

`GET /apis/certificates.k8s.io/v1/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.

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK

## Replace Status

replace status of the specified CertificateSigningRequest

### HTTP Request

`PUT /apis/certificates.k8s.io/v1/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### 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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ClusterRole | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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`

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/sig-architecture/api-conventions.md#resources
`conditions` ComponentCondition array patch strategy: 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Read Operations

## Read

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

list objects of kind ComponentStatus

### HTTP Request

`GET /api/v1/componentstatuses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# FlowSchema v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `FlowSchema`

Appears In:

- FlowSchemaList [flowcontrol/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` FlowSchemaSpec | `spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
`status` FlowSchemaStatus | `status` is the current status of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

### FlowSchemaSpec v1beta1 flowcontrol

Appears In:

- FlowSchema [flowcontrol/v1beta1]

Field | Description
--- | ---
`distinguisherMethod` FlowDistinguisherMethod | `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string.
`matchingPrecedence` integer | `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default.
`priorityLevelConfiguration` PriorityLevelConfigurationReference | `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required.
`rules` PolicyRulesWithSubjects array | `rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema.

### FlowSchemaStatus v1beta1 flowcontrol

Appears In:

- FlowSchema [flowcontrol/v1beta1]

Field | Description
--- | ---
`conditions` FlowSchemaCondition array | `conditions` is a list of the current states of FlowSchema.

### FlowSchemaList v1beta1 flowcontrol

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/sig-architecture/api-conventions.md#resources
`items` FlowSchema array | `items` is a list of FlowSchemas.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a FlowSchema

### HTTP Request

`POST /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` FlowSchema |

### Response

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

## Patch

partially update the specified FlowSchema

### HTTP Request

`PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the FlowSchema

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 FlowSchema | OK

## Replace

replace the specified FlowSchema

### HTTP Request

`PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the FlowSchema

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` FlowSchema |

### Response

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

## Delete

delete a FlowSchema

### HTTP Request

`DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the FlowSchema

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of FlowSchema

### HTTP Request

`DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified FlowSchema

### HTTP Request

`GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the FlowSchema

### Query Parameters

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

### Response

Code | Description
--- | ---
200 FlowSchema | OK

## List

list or watch objects of kind FlowSchema

### HTTP Request

`GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 FlowSchemaList | OK

## Watch

watch changes to an object of kind FlowSchema. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the FlowSchema

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of FlowSchema. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified FlowSchema

### HTTP Request

`PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the FlowSchema

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 FlowSchema | OK

## Read Status

read status of the specified FlowSchema

### HTTP Request

`GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the FlowSchema

### Query Parameters

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

### Response

Code | Description
--- | ---
200 FlowSchema | OK

## Replace Status

replace status of the specified FlowSchema

### HTTP Request

`PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the FlowSchema

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` FlowSchema |

### Response

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

# Lease v1 coordination.k8s.io

Group | Version | Kind
--- | --- | ---
`coordination.k8s.io` | `v1` | `Lease`

Other API versions of this object exist: v1beta1
Appears In:

- LeaseList [coordination/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` LeaseSpec | Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

### LeaseSpec v1 coordination

Appears In:

- Lease [coordination/v1]

Field | Description
--- | ---
`acquireTime` MicroTime | acquireTime is a time when the current lease was acquired.
`holderIdentity` string | holderIdentity contains the identity of the holder of a current lease.
`leaseDurationSeconds` integer | leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.
`leaseTransitions` integer | leaseTransitions is the number of transitions of a lease between holders.
`renewTime` MicroTime | renewTime is a time when the current holder of a lease has last updated the lease.

### LeaseList v1 coordination

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/sig-architecture/api-conventions.md#resources
`items` Lease 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a Lease

### HTTP Request

`POST /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases`

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Lease |

### Response

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

## Patch

partially update the specified Lease

### HTTP Request

`PATCH /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Lease | OK

## Replace

replace the specified Lease

### HTTP Request

`PUT /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Lease |

### Response

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

## Delete

delete a Lease

### HTTP Request

`DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}`

### Path Parameters

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

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of Lease

### HTTP Request

`DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified Lease

### HTTP Request

`GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Lease
`namespace` | 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 Lease | OK

## List

list or watch objects of kind Lease

### HTTP Request

`GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases`

### 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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 LeaseList | OK

## List All Namespaces

list or watch objects of kind Lease

### HTTP Request

`GET /apis/coordination.k8s.io/v1/leases`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 LeaseList | OK

## Watch

watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/coordination.k8s.io/v1/watch/leases`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# LocalSubjectAccessReview v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `LocalSubjectAccessReview`

Other API versions of this object exist: 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/sig-architecture/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/sig-architecture/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

## Create

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
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`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`

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` NamespaceSpec | Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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
--- | ---
`conditions` NamespaceCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a namespace's current state.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

create a Namespace

### HTTP Request

`POST /api/v1/namespaces`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Namespace |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Namespace | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Namespace |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 Namespace | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

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

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Namespace

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/namespaces`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Namespace | OK

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Namespace |

### Response

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

# Node v1 core

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

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` NodeSpec | Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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 | Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
`podCIDR` string | PodCIDR represents the pod IP range assigned to the node.
`podCIDRs` string array patch strategy: merge | podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6.
`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 strategy: merge patch merge key: type | List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See http://pr.k8s.io/79391 for an example.
`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 strategy: merge patch merge key: type | Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
`config` NodeConfigStatus | Status of the config assigned to the node via the dynamic Kubelet config feature.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

create a Node

### HTTP Request

`POST /api/v1/nodes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Node |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Node | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Node |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 Node | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Node. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /api/v1/watch/nodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Node

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Node. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/nodes`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Node | OK

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Node |

### Response

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

## Proxy Operations

## Create Connect Proxy

connect POST requests to proxy of Node

### HTTP Request

`POST /api/v1/nodes/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NodeProxyOptions

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

connect POST requests to proxy of Node

### HTTP Request

`POST /api/v1/nodes/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NodeProxyOptions
`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

connect DELETE requests to proxy of Node

### HTTP Request

`DELETE /api/v1/nodes/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NodeProxyOptions

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

connect DELETE requests to proxy of Node

### HTTP Request

`DELETE /api/v1/nodes/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NodeProxyOptions
`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

connect GET requests to proxy of Node

### HTTP Request

`GET /api/v1/nodes/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NodeProxyOptions

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

connect GET requests to proxy of Node

### HTTP Request

`GET /api/v1/nodes/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NodeProxyOptions
`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

connect HEAD requests to proxy of Node

### HTTP Request

`HEAD /api/v1/nodes/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NodeProxyOptions

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

connect HEAD requests to proxy of Node

### HTTP Request

`HEAD /api/v1/nodes/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NodeProxyOptions
`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

connect PUT requests to proxy of Node

### HTTP Request

`PUT /api/v1/nodes/{name}/proxy`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NodeProxyOptions

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

connect PUT requests to proxy of Node

### HTTP Request

`PUT /api/v1/nodes/{name}/proxy/{path}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the NodeProxyOptions
`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.
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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]
- VolumeAttachmentSource [storage/v1]
- VolumeAttachmentSource [storage/v1beta1]
- VolumeAttachmentSource [storage/v1alpha1]

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` CinderPersistentVolumeSource | Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/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 is 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` GlusterfsPersistentVolumeSource | Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/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.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

create a PersistentVolume

### HTTP Request

`POST /api/v1/persistentvolumes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolume |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PersistentVolume | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolume |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PersistentVolume | OK
202 PersistentVolume | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 PersistentVolume | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /api/v1/watch/persistentvolumes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PersistentVolume

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/persistentvolumes`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PersistentVolume | OK

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PersistentVolume |

### Response

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

# PriorityLevelConfiguration v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `PriorityLevelConfiguration`

Appears In:

- PriorityLevelConfigurationList [flowcontrol/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` PriorityLevelConfigurationSpec | `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
`status` PriorityLevelConfigurationStatus | `status` is the current status of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

### PriorityLevelConfigurationSpec v1beta1 flowcontrol

Appears In:

- PriorityLevelConfiguration [flowcontrol/v1beta1]

Field | Description
--- | ---
`limited` LimitedPriorityLevelConfiguration | `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`.
`type` string | `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required.

### PriorityLevelConfigurationStatus v1beta1 flowcontrol

Appears In:

- PriorityLevelConfiguration [flowcontrol/v1beta1]

Field | Description
--- | ---
`conditions` PriorityLevelConfigurationCondition array | `conditions` is the current state of "request-priority".

### PriorityLevelConfigurationList v1beta1 flowcontrol

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/sig-architecture/api-conventions.md#resources
`items` PriorityLevelConfiguration array | `items` is a list of request-priorities.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a PriorityLevelConfiguration

### HTTP Request

`POST /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityLevelConfiguration |

### Response

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

## Patch

partially update the specified PriorityLevelConfiguration

### HTTP Request

`PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityLevelConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PriorityLevelConfiguration | OK

## Replace

replace the specified PriorityLevelConfiguration

### HTTP Request

`PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityLevelConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityLevelConfiguration |

### Response

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

## Delete

delete a PriorityLevelConfiguration

### HTTP Request

`DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityLevelConfiguration

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of PriorityLevelConfiguration

### HTTP Request

`DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified PriorityLevelConfiguration

### HTTP Request

`GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityLevelConfiguration

### Query Parameters

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

### Response

Code | Description
--- | ---
200 PriorityLevelConfiguration | OK

## List

list or watch objects of kind PriorityLevelConfiguration

### HTTP Request

`GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 PriorityLevelConfigurationList | OK

## Watch

watch changes to an object of kind PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/prioritylevelconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityLevelConfiguration

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/prioritylevelconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified PriorityLevelConfiguration

### HTTP Request

`PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityLevelConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PriorityLevelConfiguration | OK

## Read Status

read status of the specified PriorityLevelConfiguration

### HTTP Request

`GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityLevelConfiguration

### Query Parameters

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

### Response

Code | Description
--- | ---
200 PriorityLevelConfiguration | OK

## Replace Status

replace status of the specified PriorityLevelConfiguration

### HTTP Request

`PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityLevelConfiguration

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityLevelConfiguration |

### Response

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

# ResourceQuota v1 core

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

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` ResourceQuotaSpec | Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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/
`scopeSelector` ScopeSelector | scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ResourceQuota |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ResourceQuota | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ResourceQuota |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ResourceQuota | OK
202 ResourceQuota | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 ResourceQuota | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind ResourceQuota

### HTTP Request

`GET /api/v1/resourcequotas`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/resourcequotas`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ResourceQuota | OK

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### 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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Role | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/roles`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/roles`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 RoleBinding | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# RuntimeClass v1 node.k8s.io

Group | Version | Kind
--- | --- | ---
`node.k8s.io` | `v1` | `RuntimeClass`

Other API versions of this object exist: v1beta1 v1alpha1
Appears In:

- RuntimeClassList [node/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/sig-architecture/api-conventions.md#resources
`handler` string | Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`overhead` Overhead | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/ This field is in beta starting v1.18 and is only honored by servers that enable the PodOverhead feature.
`scheduling` Scheduling | Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes.

### RuntimeClassList v1 node

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/sig-architecture/api-conventions.md#resources
`items` RuntimeClass 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a RuntimeClass

### HTTP Request

`POST /apis/node.k8s.io/v1/runtimeclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RuntimeClass |

### Response

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

## Patch

partially update the specified RuntimeClass

### HTTP Request

`PATCH /apis/node.k8s.io/v1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 RuntimeClass | OK

## Replace

replace the specified RuntimeClass

### HTTP Request

`PUT /apis/node.k8s.io/v1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RuntimeClass |

### Response

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

## Delete

delete a RuntimeClass

### HTTP Request

`DELETE /apis/node.k8s.io/v1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of RuntimeClass

### HTTP Request

`DELETE /apis/node.k8s.io/v1/runtimeclasses`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified RuntimeClass

### HTTP Request

`GET /apis/node.k8s.io/v1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

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

### Response

Code | Description
--- | ---
200 RuntimeClass | OK

## List

list or watch objects of kind RuntimeClass

### HTTP Request

`GET /apis/node.k8s.io/v1/runtimeclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RuntimeClassList | OK

## Watch

watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/node.k8s.io/v1/watch/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/node.k8s.io/v1/watch/runtimeclasses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

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/sig-architecture/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/sig-architecture/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

## Create

create a SelfSubjectAccessReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews`

### Query Parameters

Parameter | Description
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` SelfSubjectAccessReview |

### Response

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

# SelfSubjectRulesReview v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `SelfSubjectRulesReview`

Other API versions of this object exist: 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/sig-architecture/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/sig-architecture/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

## Create

create a SelfSubjectRulesReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews`

### Query Parameters

Parameter | Description
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`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`

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`secrets` ObjectReference array patch strategy: merge patch merge key: name | Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret

### 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ServiceAccount |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ServiceAccount | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ServiceAccount |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ServiceAccount | OK
202 ServiceAccount | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 ServiceAccount | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind ServiceAccount

### HTTP Request

`GET /api/v1/serviceaccounts`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/serviceaccounts`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# StorageVersion v1alpha1 internal.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`internal.apiserver.k8s.io` | `v1alpha1` | `StorageVersion`

Appears In:

- StorageVersionList [apiserverinternal/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | The name is <group>.<resource>.
`spec` StorageVersionSpec | Spec is an empty spec. It is here to comply with Kubernetes API style.
`status` StorageVersionStatus | API server instances report the version they can decode and the version they encode objects to when persisting objects in the backend.

### StorageVersionSpec v1alpha1 apiserverinternal

Appears In:

- StorageVersion [apiserverinternal/v1alpha1]

Field | Description
--- | ---

### StorageVersionStatus v1alpha1 apiserverinternal

Appears In:

- StorageVersion [apiserverinternal/v1alpha1]

Field | Description
--- | ---
`commonEncodingVersion` string | If all API server instances agree on the same encoding storage version, then this field is set to that version. Otherwise this field is left empty. API servers should finish updating its storageVersionStatus entry before serving write operations, so that this field will be in sync with the reality.
`conditions` StorageVersionCondition array | The latest available observations of the storageVersion's state.
`storageVersions` ServerStorageVersion array | The reported versions per API server instance.

### StorageVersionList v1alpha1 apiserverinternal

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/sig-architecture/api-conventions.md#resources
`items` StorageVersion 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta |

## Write Operations

## Create

create a StorageVersion

### HTTP Request

`POST /apis/internal.apiserver.k8s.io/v1alpha1/storageversions`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageVersion |

### Response

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

## Patch

partially update the specified StorageVersion

### HTTP Request

`PATCH /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageVersion

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 StorageVersion | OK

## Replace

replace the specified StorageVersion

### HTTP Request

`PUT /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageVersion

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageVersion |

### Response

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

## Delete

delete a StorageVersion

### HTTP Request

`DELETE /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageVersion

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of StorageVersion

### HTTP Request

`DELETE /apis/internal.apiserver.k8s.io/v1alpha1/storageversions`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified StorageVersion

### HTTP Request

`GET /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageVersion

### Query Parameters

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

### Response

Code | Description
--- | ---
200 StorageVersion | OK

## List

list or watch objects of kind StorageVersion

### HTTP Request

`GET /apis/internal.apiserver.k8s.io/v1alpha1/storageversions`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 StorageVersionList | OK

## Watch

watch changes to an object of kind StorageVersion. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/internal.apiserver.k8s.io/v1alpha1/watch/storageversions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageVersion

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of StorageVersion. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/internal.apiserver.k8s.io/v1alpha1/watch/storageversions`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified StorageVersion

### HTTP Request

`PATCH /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageVersion

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 StorageVersion | OK

## Read Status

read status of the specified StorageVersion

### HTTP Request

`GET /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageVersion

### Query Parameters

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

### Response

Code | Description
--- | ---
200 StorageVersion | OK

## Replace Status

replace status of the specified StorageVersion

### HTTP Request

`PUT /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageVersion

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageVersion |

### Response

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

# SubjectAccessReview v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `SubjectAccessReview`

Other API versions of this object exist: 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/sig-architecture/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/sig-architecture/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

## Create

create a SubjectAccessReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1/subjectaccessreviews`

### Query Parameters

Parameter | Description
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`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

# TokenRequest v1 authentication.k8s.io

Group | Version | Kind
--- | --- | ---
`authentication.k8s.io` | `v1` | `TokenRequest`

Other API versions of this object exist: 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta |
`spec` TokenRequestSpec |
`status` TokenRequestStatus |

### TokenRequestSpec v1 authentication

Appears In:

- TokenRequest [authentication/v1]

Field | Description
--- | ---
`audiences` string array | Audiences are the intendend audiences of the token. A recipient of a token must identitfy themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.
`boundObjectRef` BoundObjectReference | BoundObjectRef is a reference to an object that the token will be bound to. The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation.
`expirationSeconds` integer | ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response.

### TokenRequestStatus v1 authentication

Appears In:

- TokenRequest [authentication/v1]

Field | Description
--- | ---
`expirationTimestamp` Time | ExpirationTimestamp is the time of expiration of the returned token.
`token` string | Token is the opaque bearer token.

# TokenReview v1 authentication.k8s.io

Group | Version | Kind
--- | --- | ---
`authentication.k8s.io` | `v1` | `TokenReview`

Other API versions of this object exist: 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/sig-architecture/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/sig-architecture/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
--- | ---
`audiences` string array | Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver.
`token` string | Token is the opaque bearer token.

### TokenReviewStatus v1 authentication

Appears In:

- TokenReview [authentication/v1]

Field | Description
--- | ---
`audiences` string array | Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server.
`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

## Create

create a TokenReview

### HTTP Request

`POST /apis/authentication.k8s.io/v1/tokenreviews`

### Query Parameters

Parameter | Description
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`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`

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` NetworkPolicy |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 NetworkPolicy | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` NetworkPolicy |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 NetworkPolicy | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind NetworkPolicy

### HTTP Request

`GET /apis/networking.k8s.io/v1/networkpolicies`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/networking.k8s.io/v1/watch/networkpolicies`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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/sig-architecture/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/sig-architecture/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.
`storageVersionHash` string | The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.
`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.k8s.io

Group | Version | Kind
--- | --- | ---
`apiregistration.k8s.io` | `v1` | `APIServiceCondition`

APIServiceCondition describes the state of an APIService at a particular point

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/sig-architecture/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/sig-architecture/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.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `AggregationRule`

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

Other API versions of this object exist: v1beta1 v1alpha1
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

## AllowedCSIDriver v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `AllowedCSIDriver`

AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used.

Appears In:

- PodSecurityPolicySpec [policy/v1beta1]

Field | Description
--- | ---
`name` string | Name is the registered name of the CSI driver

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

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 | pathPrefix is the path prefix that the host volume must match. It does not support `*`. Trailing slashes are trimmed when validating the path prefix with a host path. Examples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo`
`readOnly` boolean | when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly.

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

## BoundObjectReference v1 authentication.k8s.io

Group | Version | Kind
--- | --- | ---
`authentication.k8s.io` | `v1` | `BoundObjectReference`

BoundObjectReference is a reference to an object that a token is bound to.

Appears In:

- TokenRequestSpec [authentication/v1]

Field | Description
--- | ---
`apiVersion` string | API version of the referent.
`kind` string | Kind of the referent. Valid kinds are 'Pod' and 'Secret'.
`name` string | Name of the referent.
`uid` string | UID of the referent.

## CSINodeDriver v1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1` | `CSINodeDriver`

CSINodeDriver holds information about the specification of one CSI driver installed on a node

Other API versions of this object exist: v1beta1
Appears In:

- CSINodeSpec [storage/v1]

Field | Description
--- | ---
`allocatable` VolumeNodeResources | allocatable represents the volume resources of a node that are available for scheduling. This field is beta.
`name` string | This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.
`nodeID` string | nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.
`topologyKeys` string array | topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.

## 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
--- | ---
`controllerExpandSecretRef` SecretReference | ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. 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.
`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".
`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.

## CSIVolumeSource v1 core

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

Represents a source location of a volume to mount, managed by an external CSI driver

Appears In:

- Volume [core/v1]

Field | Description
--- | ---
`driver` string | Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
`fsType` string | Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
`nodePublishSecretRef` LocalObjectReference | 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 secret references are passed.
`readOnly` boolean | Specifies a read-only configuration for the volume. Defaults to false (read/write).
`volumeAttributes` object | VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

## 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://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
`user` string | Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
`user` string | Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

## CertificateSigningRequestCondition v1 certificates.k8s.io

Group | Version | Kind
--- | --- | ---
`certificates.k8s.io` | `v1` | `CertificateSigningRequestCondition`

CertificateSigningRequestCondition describes a condition of a CertificateSigningRequest object

Other API versions of this object exist: v1beta1
Appears In:

- CertificateSigningRequestStatus [certificates/v1]

Field | Description
--- | ---
`lastTransitionTime` Time | lastTransitionTime is the time the condition last transitioned from one status to another. If unset, when a new condition type is added or an existing condition's status is changed, the server defaults this to the current time.
`lastUpdateTime` Time | lastUpdateTime is the time of the last update to this condition
`message` string | message contains a human readable message with details about the request state
`reason` string | reason indicates a brief reason for the request state
`status` string | status of the condition, one of True, False, Unknown. Approved, Denied, and Failed conditions may not be "False" or "Unknown".
`type` string | type of the condition. Known conditions are "Approved", "Denied", and "Failed". An "Approved" condition is added via the /approval subresource, indicating the request was approved and should be issued by the signer. A "Denied" condition is added via the /approval subresource, indicating the request was denied and should not be issued by the signer. A "Failed" condition is added via the /status subresource, indicating the signer failed to issue the certificate. Approved and Denied conditions are mutually exclusive. Approved, Denied, and Failed conditions cannot be removed once added. Only one condition of a given type is allowed.

## CinderPersistentVolumeSource v1 core

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

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

Appears In:

- PersistentVolumeSpec [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://examples.k8s.io/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://examples.k8s.io/mysql-cinder-pd/README.md
`secretRef` SecretReference | Optional: points to a secret object containing parameters used to connect to OpenStack.
`volumeID` string | volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

## 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:

- 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://examples.k8s.io/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://examples.k8s.io/mysql-cinder-pd/README.md
`secretRef` LocalObjectReference | Optional: points to a secret object containing parameters used to connect to OpenStack.
`volumeID` string | volume id used to identify the volume in cinder. More info: https://examples.k8s.io/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"

## Condition v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Condition`

Condition contains details for one aspect of the current state of this API Resource.

Appears In:

- PodDisruptionBudgetStatus [policy/v1]
- PodDisruptionBudgetStatus [policy/v1beta1]
- ServiceStatus [core/v1]

Field | Description
--- | ---
`lastTransitionTime` Time | lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
`message` string | message is a human readable message indicating details about the transition. This may be an empty string.
`observedGeneration` integer | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
`reason` string | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
`status` string | status of the condition, one of True, False, Unknown.
`type` string | type of condition in CamelCase or in foo.example.com/CamelCase.

## 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 its key must be defined

## ConfigMapNodeConfigSource v1 core

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

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.

Appears In:

- NodeConfigSource [core/v1]

Field | Description
--- | ---
`kubeletConfigKey` string | KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
`name` string | Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
`namespace` string | Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
`resourceVersion` string | ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
`uid` string | UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

## 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 its 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 used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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 its 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]
- EphemeralContainer [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, TCP, or SCTP. Defaults to "TCP".

## ContainerResourceMetricSource v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `ContainerResourceMetricSource`

ContainerResourceMetricSource 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.

Other API versions of this object exist: v2beta1
Appears In:

- MetricSpec [autoscaling/v2beta2]

Field | Description
--- | ---
`container` string | container is the name of the container in the pods of the scaling target
`name` string | name is the name of the resource in question.
`target` MetricTarget | target specifies the target value for the given metric

## ContainerResourceMetricStatus v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `ContainerResourceMetricStatus`

ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in 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.

Other API versions of this object exist: v2beta1
Appears In:

- MetricStatus [autoscaling/v2beta2]

Field | Description
--- | ---
`container` string | Container is the name of the container in the pods of the scaling target
`current` MetricValueStatus | current contains the current value for the given metric
`name` string | Name is the name of the resource in question.

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

CrossVersionObjectReference contains enough information to let you identify the referred resource.

Other API versions of this object exist: v2beta2 v2beta1
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/sig-architecture/api-conventions.md#types-kinds"
`name` string | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

## CustomResourceColumnDefinition v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `CustomResourceColumnDefinition`

CustomResourceColumnDefinition specifies a column for server side printing.

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceDefinitionVersion [apiextensions/v1]

Field | Description
--- | ---
`description` string | description is a human readable description of this column.
`format` string | format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
`jsonPath` string | jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.
`name` string | name is a human readable name for the column.
`priority` integer | priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0.
`type` string | type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.

## CustomResourceConversion v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `CustomResourceConversion`

CustomResourceConversion describes how to convert different versions of a CR.

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceDefinitionSpec [apiextensions/v1]

Field | Description
--- | ---
`strategy` string | strategy specifies how custom resources are converted between versions. Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set.
`webhook` WebhookConversion | webhook describes how to call the conversion webhook. Required when `strategy` is set to `Webhook`.

## CustomResourceDefinitionCondition v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `CustomResourceDefinitionCondition`

CustomResourceDefinitionCondition contains details for the current condition of this pod.

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceDefinitionStatus [apiextensions/v1]

Field | Description
--- | ---
`lastTransitionTime` Time | lastTransitionTime last time the condition transitioned from one status to another.
`message` string | message is a human-readable message indicating details about last transition.
`reason` string | reason is a 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. Types include Established, NamesAccepted and Terminating.

## CustomResourceDefinitionNames v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `CustomResourceDefinitionNames`

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceDefinitionSpec [apiextensions/v1]
- CustomResourceDefinitionStatus [apiextensions/v1]

Field | Description
--- | ---
`categories` string array | categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.
`kind` string | kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.
`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. The custom resources are served under `/apis/<group>/<version>/.../<plural>`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). Must be all lowercase.
`shortNames` string array | shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get <shortname>`. It must be all lowercase.
`singular` string | singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.

## CustomResourceDefinitionVersion v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `CustomResourceDefinitionVersion`

CustomResourceDefinitionVersion describes a version for CRD.

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceDefinitionSpec [apiextensions/v1]

Field | Description
--- | ---
`additionalPrinterColumns` CustomResourceColumnDefinition array | additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used.
`deprecated` boolean | deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
`deprecationWarning` string | deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists.
`name` string | name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis/<group>/<version>/...` if `served` is true.
`schema` CustomResourceValidation | schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
`served` boolean | served is a flag enabling/disabling this version from being served via REST APIs
`storage` boolean | storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
`subresources` CustomResourceSubresources | subresources specify what subresources this version of the defined custom resource have.

## CustomResourceSubresourceScale v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `CustomResourceSubresourceScale`

CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceSubresources [apiextensions/v1]

Field | Description
--- | ---
`labelSelectorPath` string | labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string.
`specReplicasPath` string | specReplicasPath defines the JSON path inside of a custom resource 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 custom resource, the `/scale` subresource will return an error on GET.
`statusReplicasPath` string | statusReplicasPath defines the JSON path inside of a custom resource 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 custom resource, the `status.replicas` value in the `/scale` subresource will default to 0.

## CustomResourceSubresourceStatus v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `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

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceSubresources [apiextensions/v1]

Field | Description
--- | ---

## CustomResourceSubresources v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `CustomResourceSubresources`

CustomResourceSubresources defines the status and scale subresources for CustomResources.

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceDefinitionVersion [apiextensions/v1]

Field | Description
--- | ---
`scale` CustomResourceSubresourceScale | scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object.
`status` CustomResourceSubresourceStatus | status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object.

## CustomResourceValidation v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `CustomResourceValidation`

CustomResourceValidation is a list of validation methods for CustomResources.

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceDefinitionVersion [apiextensions/v1]

Field | Description
--- | ---
`openAPIV3Schema` JSONSchemaProps | openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.

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

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`

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/sig-architecture/api-conventions.md#resources
`dryRun` string array | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`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/sig-architecture/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`

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 used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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 Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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

## Endpoint v1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1` | `Endpoint`

Endpoint represents a single logical "backend" implementing a service.

Other API versions of this object exist: v1beta1
Appears In:

- EndpointSlice [discovery/v1]

Field | Description
--- | ---
`addresses` string array | addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100.
`conditions` EndpointConditions | conditions contains information about the current status of the endpoint.
`deprecatedTopology` object | deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead.
`hints` EndpointHints | hints contains information associated with how an endpoint should be consumed.
`hostname` string | hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.
`nodeName` string | nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate.
`targetRef` ObjectReference | targetRef is a reference to a Kubernetes object that represents this endpoint.
`zone` string | zone is the name of the Zone this endpoint exists in.

## 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.

## EndpointConditions v1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1` | `EndpointConditions`

EndpointConditions represents the current condition of an endpoint.

Other API versions of this object exist: v1beta1
Appears In:

- Endpoint [discovery/v1]

Field | Description
--- | ---
`ready` boolean | ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints.
`serving` boolean | serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
`terminating` boolean | terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.

## EndpointHints v1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1` | `EndpointHints`

EndpointHints provides hints describing how an endpoint should be consumed.

Other API versions of this object exist: v1beta1
Appears In:

- Endpoint [discovery/v1]

Field | Description
--- | ---
`forZones` ForZone array | forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing.

## EndpointPort v1 core

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

EndpointPort is a tuple that describes a single port.

Other API versions of this object exist: v1beta1
Appears In:

- EndpointSubset [core/v1]

Field | Description
--- | ---
`appProtocol` string | The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default.
`name` string | The name of this port. This must match the 'name' field in the corresponding ServicePort. 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, TCP, or SCTP. 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]
- EphemeralContainer [core/v1]

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]
- EphemeralContainer [core/v1]

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['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
`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

## EphemeralContainer v1 core

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

An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.

Appears In:

- EphemeralContainers [core/v1]
- 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 strategy: 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
`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 | Lifecycle is not allowed for ephemeral containers.
`livenessProbe` Probe | Probes are not allowed for ephemeral containers.
`name` string | Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
`ports` ContainerPort array | Ports are not allowed for ephemeral containers.
`readinessProbe` Probe | Probes are not allowed for ephemeral containers.
`resources` ResourceRequirements | Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
`securityContext` SecurityContext | SecurityContext is not allowed for ephemeral containers.
`startupProbe` Probe | Probes are not allowed for ephemeral containers.
`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
`targetContainerName` string | If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature.
`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 strategy: merge patch merge key: devicePath | volumeDevices is the list of block devices to be used by the container.
`volumeMounts` VolumeMount array patch strategy: 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.

## EphemeralContainers v1 core

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

A list of ephemeral containers used with the Pod ephemeralcontainers subresource.

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/sig-architecture/api-conventions.md#resources
`ephemeralContainers` EphemeralContainer array patch strategy: merge patch merge key: name | A list of ephemeral containers associated with this pod. New ephemeral containers may be appended to this list, but existing ephemeral containers may not be removed or modified.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta |

## EphemeralVolumeSource v1 core

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

Represents an ephemeral volume that is handled by a normal storage driver.

Appears In:

- Volume [core/v1]

Field | Description
--- | ---
`volumeClaimTemplate` PersistentVolumeClaimTemplate | Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.

## EventSeries v1 events.k8s.io

Group | Version | Kind
--- | --- | ---
`events.k8s.io` | `v1` | `EventSeries`

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations.

Other API versions of this object exist: v1beta1
Appears In:

- Event [events/v1]

Field | Description
--- | ---
`count` integer | count is the number of occurrences in this series up to the last heartbeat time.
`lastObservedTime` MicroTime | lastObservedTime is the time when last Event from the series was seen before last heartbeat.

## EventSource v1 core

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

EventSource contains information for an event.

Appears In:

- Event [core/v1]
- Event [events/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/sig-architecture/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/sig-architecture/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 v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `ExternalDocumentation`

ExternalDocumentation allows referencing an external resource for extended documentation.

Other API versions of this object exist: v1beta1
Appears In:

- JSONSchemaProps [apiextensions/v1]

Field | Description
--- | ---
`description` string |
`url` string |

## ExternalMetricSource v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `ExternalMetricSource`

ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).

Other API versions of this object exist: v2beta1
Appears In:

- MetricSpec [autoscaling/v2beta2]

Field | Description
--- | ---
`metric` MetricIdentifier | metric identifies the target metric by name and selector
`target` MetricTarget | target specifies the target value for the given metric

## ExternalMetricStatus v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `ExternalMetricStatus`

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

Other API versions of this object exist: v2beta1
Appears In:

- MetricStatus [autoscaling/v2beta2]

Field | Description
--- | ---
`current` MetricValueStatus | current contains the current value for the given metric
`metric` MetricIdentifier | metric identifies the target metric by name and selector

## 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 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. Required for MustRunAs.
`rule` string | rule is the strategy that will dictate what FSGroup is used in the SecurityContext.

## FieldsV1 v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `FieldsV1`

FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff

Appears In:

- ManagedFieldsEntry [meta/v1]

Field | Description
--- | ---

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

## FlowDistinguisherMethod v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `FlowDistinguisherMethod`

FlowDistinguisherMethod specifies the method of a flow distinguisher.

Appears In:

- FlowSchemaSpec [flowcontrol/v1beta1]

Field | Description
--- | ---
`type` string | `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required.

## FlowSchemaCondition v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `FlowSchemaCondition`

FlowSchemaCondition describes conditions for a FlowSchema.

Appears In:

- FlowSchemaStatus [flowcontrol/v1beta1]

Field | Description
--- | ---
`lastTransitionTime` Time | `lastTransitionTime` is the last time the condition transitioned from one status to another.
`message` string | `message` is a human-readable message indicating details about last transition.
`reason` string | `reason` is a 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. Required.
`type` string | `type` is the type of the condition. Required.

## ForZone v1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1` | `ForZone`

ForZone provides information about which zones should consume this endpoint.

Other API versions of this object exist: v1beta1
Appears In:

- EndpointHints [discovery/v1]

Field | Description
--- | ---
`name` string | name represents the name of the zone.

## 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. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

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.

## GlusterfsPersistentVolumeSource v1 core

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

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Appears In:

- PersistentVolumeSpec [core/v1]

Field | Description
--- | ---
`endpoints` string | EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
`endpointsNamespace` string | EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
`path` string | Path is the Glusterfs volume path. More info: https://examples.k8s.io/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://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

## 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:

- Volume [core/v1]

Field | Description
--- | ---
`endpoints` string | EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
`path` string | Path is the Glusterfs volume path. More info: https://examples.k8s.io/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://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

## GroupSubject v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `GroupSubject`

GroupSubject holds detailed information for group-kind subject.

Appears In:

- Subject [flowcontrol/v1beta1]

Field | Description
--- | ---
`name` string | name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required.

## 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.

## HPAScalingPolicy v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `HPAScalingPolicy`

HPAScalingPolicy is a single policy which must hold true for a specified past interval.

Appears In:

- HPAScalingRules [autoscaling/v2beta2]

Field | Description
--- | ---
`periodSeconds` integer | PeriodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
`type` string | Type is used to specify the scaling policy.
`value` integer | Value contains the amount of change which is permitted by the policy. It must be greater than zero

## HPAScalingRules v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `HPAScalingRules`

HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.

Appears In:

- HorizontalPodAutoscalerBehavior [autoscaling/v2beta2]

Field | Description
--- | ---
`policies` HPAScalingPolicy array | policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
`selectPolicy` string | selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used.
`stabilizationWindowSeconds` integer | StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).

## 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 v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `HTTPIngressPath`

HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.

Other API versions of this object exist: v1beta1 v1beta1
Appears In:

- HTTPIngressRuleValue [networking/v1]

Field | Description
--- | ---
`backend` IngressBackend | Backend defines the referenced service endpoint to which the traffic will be forwarded to.
`path` string | Path is 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 '/'. When unspecified, all paths from incoming requests are matched.
`pathType` string | PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types.

## HTTPIngressRuleValue v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `HTTPIngressRuleValue`

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.

Other API versions of this object exist: v1beta1 v1beta1
Appears In:

- IngressRule [networking/v1]

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

## HorizontalPodAutoscalerBehavior v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `HorizontalPodAutoscalerBehavior`

HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

Appears In:

- HorizontalPodAutoscalerSpec [autoscaling/v2beta2]

Field | Description
--- | ---
`scaleDown` HPAScalingRules | scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).
`scaleUp` HPAScalingRules | scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of: * increase no more than 4 pods per 60 seconds * double the number of pods per 60 seconds No stabilization is used.

## HorizontalPodAutoscalerCondition v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `HorizontalPodAutoscalerCondition`

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

Other API versions of this object exist: v2beta1
Appears In:

- HorizontalPodAutoscalerStatus [autoscaling/v2beta2]

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 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `HostPortRange`

HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined.

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`

IDRange provides a min/max of an allowed range of IDs.

Appears In:

- FSGroupStrategyOptions [policy/v1beta1]
- RunAsGroupStrategyOptions [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 v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `IPBlock`

IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") 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" or "2001:db9::/64"
`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" or "2001:db9::/64" 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 v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `IngressBackend`

IngressBackend describes all endpoints for a given service and port.

Other API versions of this object exist: v1beta1 v1beta1
Appears In:

- HTTPIngressPath [networking/v1]
- IngressSpec [networking/v1]

Field | Description
--- | ---
`resource` TypedLocalObjectReference | Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service".
`service` IngressServiceBackend | Service references a Service as a Backend. This is a mutually exclusive setting with "Resource".

## IngressClassParametersReference v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `IngressClassParametersReference`

IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.

Other API versions of this object exist: v1beta1
Appears In:

- IngressClassSpec [networking/v1]

Field | Description
--- | ---
`apiGroup` string | APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
`kind` string | Kind is the type of resource being referenced.
`name` string | Name is the name of resource being referenced.
`namespace` string | Namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster".
`scope` string | Scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace". Field can be enabled with IngressClassNamespacedParams feature gate.

## IngressRule v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `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.

Other API versions of this object exist: v1beta1 v1beta1
Appears In:

- IngressSpec [networking/v1]

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 RFC 3986: 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. Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '\*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.
`http` HTTPIngressRuleValue |

## IngressServiceBackend v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `IngressServiceBackend`

IngressServiceBackend references a Kubernetes Service as a Backend.

Appears In:

- IngressBackend [networking/v1]

Field | Description
--- | ---
`name` string | Name is the referenced service. The service must exist in the same namespace as the Ingress object.
`port` ServiceBackendPort | Port of the referenced service. A port name or port number is required for a IngressServiceBackend.

## IngressTLS v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `IngressTLS`

IngressTLS describes the transport layer security associated with an Ingress.

Other API versions of this object exist: v1beta1 v1beta1
Appears In:

- IngressSpec [networking/v1]

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 TLS traffic on port 443. Field is left optional to allow TLS 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.

## JSON v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `JSON`

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

Other API versions of this object exist: v1beta1
Appears In:

- JSONSchemaProps [apiextensions/v1]

Field | Description
--- | ---

## JSONSchemaProps v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `JSONSchemaProps`

JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

Other API versions of this object exist: v1beta1
Appears In:

- CustomResourceValidation [apiextensions/v1]
- JSONSchemaProps [apiextensions/v1]

Field | Description
--- | ---
`$ref` string |
`$schema` string |
`additionalItems` JSONSchemaPropsOrBool |
`additionalProperties` JSONSchemaPropsOrBool |
`allOf` JSONSchemaProps array |
`anyOf` JSONSchemaProps array |
`default` JSON | default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
`definitions` object |
`dependencies` object |
`description` string |
`enum` JSON array |
`example` JSON |
`exclusiveMaximum` boolean |
`exclusiveMinimum` boolean |
`externalDocs` ExternalDocumentation |
`format` string | format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: - bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
`id` string |
`items` JSONSchemaPropsOrArray |
`maxItems` integer |
`maxLength` integer |
`maxProperties` integer |
`maximum` number |
`minItems` integer |
`minLength` integer |
`minProperties` integer |
`minimum` number |
`multipleOf` number |
`not` JSONSchemaProps |
`nullable` boolean |
`oneOf` JSONSchemaProps array |
`pattern` string |
`patternProperties` object |
`properties` object |
`required` string array |
`title` string |
`type` string |
`uniqueItems` boolean |
`x-kubernetes-embedded-resource` boolean | x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
`x-kubernetes-int-or-string` boolean | x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: 1) anyOf: - type: integer - type: string 2) allOf: - anyOf: - type: integer - type: string - ... zero or more
`x-kubernetes-list-map-keys` string array | x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
`x-kubernetes-list-type` string | x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: 1) `atomic`: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...). 2) `set`: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type `atomic` or an array with x-kubernetes-list-type `atomic`. 3) `map`: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.
`x-kubernetes-map-type` string | x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: 1) `granular`: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2) `atomic`: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.
`x-kubernetes-preserve-unknown-fields` boolean | x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.

## JSONSchemaPropsOrArray v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `JSONSchemaPropsOrArray`

JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.

Other API versions of this object exist: v1beta1
Appears In:

- JSONSchemaProps [apiextensions/v1]

Field | Description
--- | ---

## JSONSchemaPropsOrBool v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `JSONSchemaPropsOrBool`

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

Other API versions of this object exist: v1beta1
Appears In:

- JSONSchemaProps [apiextensions/v1]

Field | Description
--- | ---

## 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 v1 batch

Group | Version | Kind
--- | --- | ---
`batch` | `v1` | `JobTemplateSpec`

JobTemplateSpec describes the data a Job should have when created from a template

Other API versions of this object exist: v1beta1
Appears In:

- CronJobSpec [batch/v1]

Field | Description
--- | ---
`metadata` ObjectMeta | Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` JobSpec | Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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 used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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]
- CSIStorageCapacity [storage/v1beta1]
- CSIStorageCapacity [storage/v1alpha1]
- DaemonSetSpec [apps/v1]
- DeploymentSpec [apps/v1]
- ExternalMetricSource [autoscaling/v2beta1]
- ExternalMetricStatus [autoscaling/v2beta1]
- JobSpec [batch/v1]
- MetricIdentifier [autoscaling/v2beta2]
- MutatingWebhook [admissionregistration/v1]
- MutatingWebhook [admissionregistration/v1beta1]
- NetworkPolicyPeer [networking/v1]
- NetworkPolicySpec [networking/v1]
- ObjectMetricSource [autoscaling/v2beta1]
- ObjectMetricStatus [autoscaling/v2beta1]
- PersistentVolumeClaimSpec [core/v1]
- PodAffinityTerm [core/v1]
- PodDisruptionBudgetSpec [policy/v1]
- PodDisruptionBudgetSpec [policy/v1beta1]
- PodsMetricSource [autoscaling/v2beta1]
- PodsMetricStatus [autoscaling/v2beta1]
- ReplicaSetSpec [apps/v1]
- StatefulSetSpec [apps/v1]
- TopologySpreadConstraint [core/v1]
- ValidatingWebhook [admissionregistration/v1]
- ValidatingWebhook [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 strategy: 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]
- EphemeralContainer [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 due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. 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.

## LimitResponse v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `LimitResponse`

LimitResponse defines how to handle requests that can not be executed right now.

Appears In:

- LimitedPriorityLevelConfiguration [flowcontrol/v1beta1]

Field | Description
--- | ---
`queuing` QueuingConfiguration | `queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`.
`type` string | `type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required.

## LimitedPriorityLevelConfiguration v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `LimitedPriorityLevelConfiguration`

LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: * How are requests for this priority level limited? * What should be done with requests that exceed the limit?

Appears In:

- PriorityLevelConfigurationSpec [flowcontrol/v1beta1]

Field | Description
--- | ---
`assuredConcurrencyShares` integer | `assuredConcurrencyShares` (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. ACS must be a positive number. The server's concurrency limit (SCL) is divided among the concurrency-controlled priority levels in proportion to their assured concurrency shares. This produces the assured concurrency value (ACV) --- the number of requests that may be executing at a time --- for each such priority level: ACV(l) = ceil( SCL * ACS(l) / ( sum[priority levels k] ACS(k) ) ) bigger numbers of ACS mean more reserved concurrent requests (at the expense of every other PL). This field has a default value of 30.
`limitResponse` LimitResponse | `limitResponse` indicates what to do with requests that can not be executed right now

## 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]
- CSIDriverList [storage/v1]
- CSIDriverList [storage/v1beta1]
- CSINodeList [storage/v1]
- CSINodeList [storage/v1beta1]
- CSIStorageCapacityList [storage/v1beta1]
- CSIStorageCapacityList [storage/v1alpha1]
- CertificateSigningRequestList [certificates/v1]
- 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]
- CronJobList [batch/v1]
- CronJobList [batch/v1beta1]
- CustomResourceDefinitionList [apiextensions/v1]
- CustomResourceDefinitionList [apiextensions/v1beta1]
- DaemonSetList [apps/v1]
- DeploymentList [apps/v1]
- EndpointSliceList [discovery/v1]
- EndpointSliceList [discovery/v1beta1]
- EndpointsList [core/v1]
- EventList [core/v1]
- EventList [events/v1]
- EventList [events/v1beta1]
- FlowSchemaList [flowcontrol/v1beta1]
- HorizontalPodAutoscalerList [autoscaling/v1]
- HorizontalPodAutoscalerList [autoscaling/v2beta2]
- HorizontalPodAutoscalerList [autoscaling/v2beta1]
- IngressClassList [networking/v1]
- IngressClassList [networking/v1beta1]
- IngressList [networking/v1]
- IngressList [extensions/v1beta1]
- IngressList [networking/v1beta1]
- JobList [batch/v1]
- LeaseList [coordination/v1]
- LeaseList [coordination/v1beta1]
- LimitRangeList [core/v1]
- MutatingWebhookConfigurationList [admissionregistration/v1]
- MutatingWebhookConfigurationList [admissionregistration/v1beta1]
- NamespaceList [core/v1]
- NetworkPolicyList [networking/v1]
- NodeList [core/v1]
- PersistentVolumeClaimList [core/v1]
- PersistentVolumeList [core/v1]
- PodDisruptionBudgetList [policy/v1]
- PodDisruptionBudgetList [policy/v1beta1]
- PodList [core/v1]
- PodSecurityPolicyList [policy/v1beta1]
- PodTemplateList [core/v1]
- PriorityClassList [scheduling/v1]
- PriorityClassList [scheduling/v1beta1]
- PriorityClassList [scheduling/v1alpha1]
- PriorityLevelConfigurationList [flowcontrol/v1beta1]
- ReplicaSetList [apps/v1]
- ReplicationControllerList [core/v1]
- ResourceQuotaList [core/v1]
- RoleBindingList [rbac/v1]
- RoleBindingList [rbac/v1beta1]
- RoleBindingList [rbac/v1alpha1]
- RoleList [rbac/v1]
- RoleList [rbac/v1beta1]
- RoleList [rbac/v1alpha1]
- RuntimeClassList [node/v1]
- RuntimeClassList [node/v1beta1]
- RuntimeClassList [node/v1alpha1]
- SecretList [core/v1]
- ServiceAccountList [core/v1]
- ServiceList [core/v1]
- StatefulSetList [apps/v1]
- Status [meta/v1]
- StorageClassList [storage/v1]
- StorageClassList [storage/v1beta1]
- StorageVersionList [apiserverinternal/v1alpha1]
- ValidatingWebhookConfigurationList [admissionregistration/v1]
- ValidatingWebhookConfigurationList [admissionregistration/v1beta1]
- VolumeAttachmentList [storage/v1]
- 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 consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
`remainingItemCount` integer | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
`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/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`selfLink` string | selfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

## 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)
`ports` PortStatus array | Ports is a list of records of service ports If used, every port defined in the service should have an entry in it

## LoadBalancerStatus v1 core

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

LoadBalancerStatus represents the status of a load-balancer.

Appears In:

- IngressStatus [networking/v1]
- IngressStatus [extensions/v1beta1]
- IngressStatus [networking/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:

- CSIVolumeSource [core/v1]
- CephFSVolumeSource [core/v1]
- CinderVolumeSource [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 (Beta feature)

Appears In:

- PersistentVolumeSpec [core/v1]

Field | Description
--- | ---
`fsType` string | Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified.
`path` string | The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).

## ManagedFieldsEntry v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `ManagedFieldsEntry`

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Appears In:

- ObjectMeta [meta/v1]

Field | Description
--- | ---
`apiVersion` string | APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
`fieldsType` string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
`fieldsV1` FieldsV1 | FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
`manager` string | Manager is an identifier of the workflow managing these fields.
`operation` string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
`time` Time | Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

## MetricIdentifier v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `MetricIdentifier`

MetricIdentifier defines the name and optionally selector for a metric

Appears In:

- ExternalMetricSource [autoscaling/v2beta2]
- ExternalMetricStatus [autoscaling/v2beta2]
- ObjectMetricSource [autoscaling/v2beta2]
- ObjectMetricStatus [autoscaling/v2beta2]
- PodsMetricSource [autoscaling/v2beta2]
- PodsMetricStatus [autoscaling/v2beta2]

Field | Description
--- | ---
`name` string | name is the name of the given metric
`selector` LabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

## MetricSpec v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `MetricSpec`

MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).

Other API versions of this object exist: v2beta1
Appears In:

- HorizontalPodAutoscalerSpec [autoscaling/v2beta2]

Field | Description
--- | ---
`containerResource` ContainerResourceMetricSource | container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of 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. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
`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 "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled

## MetricStatus v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `MetricStatus`

MetricStatus describes the last-read state of a single metric.

Other API versions of this object exist: v2beta1
Appears In:

- HorizontalPodAutoscalerStatus [autoscaling/v2beta2]

Field | Description
--- | ---
`containerResource` ContainerResourceMetricStatus | container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in 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.
`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 "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled

## MetricTarget v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `MetricTarget`

MetricTarget defines the target value, average value, or average utilization of a specific metric

Appears In:

- ContainerResourceMetricSource [autoscaling/v2beta2]
- ExternalMetricSource [autoscaling/v2beta2]
- ObjectMetricSource [autoscaling/v2beta2]
- PodsMetricSource [autoscaling/v2beta2]
- ResourceMetricSource [autoscaling/v2beta2]

Field | Description
--- | ---
`averageUtilization` integer | averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
`averageValue` Quantity | averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
`type` string | type represents whether the metric type is Utilization, Value, or AverageValue
`value` Quantity | value is the target value of the metric (as a quantity).

## MetricValueStatus v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `MetricValueStatus`

MetricValueStatus holds the current value for a metric

Appears In:

- ContainerResourceMetricStatus [autoscaling/v2beta2]
- ExternalMetricStatus [autoscaling/v2beta2]
- ObjectMetricStatus [autoscaling/v2beta2]
- PodsMetricStatus [autoscaling/v2beta2]
- ResourceMetricStatus [autoscaling/v2beta2]

Field | Description
--- | ---
`averageUtilization` 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.
`averageValue` Quantity | averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
`value` Quantity | value is the current value of the metric (as a quantity).

## MicroTime v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `MicroTime`

MicroTime is version of Time with microsecond level precision.

Appears In:

- Event [core/v1]
- Event [events/v1]
- Event [events/v1beta1]
- EventSeries [core/v1]
- EventSeries [events/v1]
- EventSeries [events/v1beta1]
- LeaseSpec [coordination/v1]
- LeaseSpec [coordination/v1beta1]

Field | Description
--- | ---

## MutatingWebhook v1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1` | `MutatingWebhook`

MutatingWebhook describes an admission webhook and the resources and operations it applies to.

Other API versions of this object exist: v1beta1
Appears In:

- MutatingWebhookConfiguration [admissionregistration/v1]

Field | Description
--- | ---
`admissionReviewVersions` string array | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy.
`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 Fail.
`matchPolicy` string | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Equivalent"
`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.
`objectSelector` LabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
`reinvocationPolicy` string | reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". Never: the webhook will not be called more than once in a single admission evaluation. IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. Defaults to "Never".
`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.
`sideEffects` string | SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.
`timeoutSeconds` integer | TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds.

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

## NamespaceCondition v1 core

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

NamespaceCondition contains details about state of namespace.

Appears In:

- NamespaceStatus [core/v1]

Field | Description
--- | ---
`lastTransitionTime` Time |
`message` string |
`reason` string |
`status` string | Status of the condition, one of True, False, Unknown.
`type` string | Type of namespace controller condition.

## NetworkPolicyEgressRule v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `NetworkPolicyEgressRule`

NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8

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.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `NetworkPolicyIngressRule`

NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.

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 one 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.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `NetworkPolicyPeer`

NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed

Appears In:

- NetworkPolicyEgressRule [networking/v1]
- NetworkPolicyIngressRule [networking/v1]

Field | Description
--- | ---
`ipBlock` IPBlock | IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
`namespaceSelector` LabelSelector | Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
`podSelector` LabelSelector | This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.

## NetworkPolicyPort v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `NetworkPolicyPort`

NetworkPolicyPort describes a port to allow traffic on

Appears In:

- NetworkPolicyEgressRule [networking/v1]
- NetworkPolicyIngressRule [networking/v1]

Field | Description
--- | ---
`endPort` integer | If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Alpha state and should be enabled using the Feature Gate "NetworkPolicyEndPort".
`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. If present, only traffic on the specified protocol AND port will be matched.
`protocol` string | The protocol (TCP, UDP, or SCTP) 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:

- NodeConfigStatus [core/v1]
- NodeSpec [core/v1]

Field | Description
--- | ---
`configMap` ConfigMapNodeConfigSource | ConfigMap is a reference to a Node's ConfigMap

## NodeConfigStatus v1 core

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

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

Appears In:

- NodeStatus [core/v1]

Field | Description
--- | ---
`active` NodeConfigSource | Active reports the checkpointed config the node is actively using. Active will represent either the current version of the Assigned config, or the current LastKnownGood config, depending on whether attempting to use the Assigned config results in an error.
`assigned` NodeConfigSource | Assigned reports the checkpointed config the node will try to use. When Node.Spec.ConfigSource is updated, the node checkpoints the associated config payload to local disk, along with a record indicating intended config. The node refers to this record to choose its config checkpoint, and reports this record in Assigned. Assigned only updates in the status after the record has been checkpointed to disk. When the Kubelet is restarted, it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned.
`error` string | Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions.
`lastKnownGood` NodeConfigSource | LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config. The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct. This is currently implemented as a 10-minute soak period starting when the local record of Assigned config is updated. If the Assigned config is Active at the end of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, because the local default config is always assumed good. You should not make assumptions about the node's method of determining config stability and correctness, as this may change or become configurable in the future.

## 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. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Appears In:

- NodeSelector [core/v1]
- PreferredSchedulingTerm [core/v1]

Field | Description
--- | ---
`matchExpressions` NodeSelectorRequirement array | A list of node selector requirements by node's labels.
`matchFields` NodeSelectorRequirement array | A list of node selector requirements by node's fields.

## 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/uuid

## NonResourceAttributes v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `NonResourceAttributes`

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

Other API versions of this object exist: v1beta1
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

## NonResourcePolicyRule v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `NonResourcePolicyRule`

NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request.

Appears In:

- PolicyRulesWithSubjects [flowcontrol/v1beta1]

Field | Description
--- | ---
`nonResourceURLs` string array | `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: - "/healthz" is legal - "/hea*" is illegal - "/hea" is legal but matches nothing - "/hea/*" also matches nothing - "/healthz/*" matches all per-component health checks. "*" matches all non-resource urls. if it is present, it must be the only entry. Required.
`verbs` string array | `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required.

## NonResourceRule v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `NonResourceRule`

NonResourceRule holds information that describes a rule for the non-resource

Other API versions of this object exist: v1beta1
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]
- CSIDriver [storage/v1]
- CSIDriver [storage/v1beta1]
- CSINode [storage/v1]
- CSINode [storage/v1beta1]
- CSIStorageCapacity [storage/v1beta1]
- CSIStorageCapacity [storage/v1alpha1]
- CertificateSigningRequest [certificates/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]
- CronJob [batch/v1]
- CronJob [batch/v1beta1]
- CustomResourceDefinition [apiextensions/v1]
- CustomResourceDefinition [apiextensions/v1beta1]
- DaemonSet [apps/v1]
- Deployment [apps/v1]
- EndpointSlice [discovery/v1]
- EndpointSlice [discovery/v1beta1]
- Endpoints [core/v1]
- EphemeralContainers [core/v1]
- Event [core/v1]
- Event [events/v1]
- Event [events/v1beta1]
- Eviction [policy/v1beta1]
- FlowSchema [flowcontrol/v1beta1]
- HorizontalPodAutoscaler [autoscaling/v1]
- HorizontalPodAutoscaler [autoscaling/v2beta2]
- HorizontalPodAutoscaler [autoscaling/v2beta1]
- Ingress [networking/v1]
- Ingress [extensions/v1beta1]
- Ingress [networking/v1beta1]
- IngressClass [networking/v1]
- IngressClass [networking/v1beta1]
- Job [batch/v1]
- JobTemplateSpec [batch/v1]
- JobTemplateSpec [batch/v1beta1]
- Lease [coordination/v1]
- Lease [coordination/v1beta1]
- LimitRange [core/v1]
- LocalSubjectAccessReview [authorization/v1]
- LocalSubjectAccessReview [authorization/v1beta1]
- MutatingWebhookConfiguration [admissionregistration/v1]
- MutatingWebhookConfiguration [admissionregistration/v1beta1]
- Namespace [core/v1]
- NetworkPolicy [networking/v1]
- Node [core/v1]
- PersistentVolume [core/v1]
- PersistentVolumeClaim [core/v1]
- PersistentVolumeClaimTemplate [core/v1]
- Pod [core/v1]
- PodDisruptionBudget [policy/v1]
- PodDisruptionBudget [policy/v1beta1]
- PodSecurityPolicy [policy/v1beta1]
- PodTemplate [core/v1]
- PodTemplateSpec [core/v1]
- PriorityClass [scheduling/v1]
- PriorityClass [scheduling/v1beta1]
- PriorityClass [scheduling/v1alpha1]
- PriorityLevelConfiguration [flowcontrol/v1beta1]
- ReplicaSet [apps/v1]
- ReplicationController [core/v1]
- ResourceQuota [core/v1]
- Role [rbac/v1]
- Role [rbac/v1beta1]
- Role [rbac/v1alpha1]
- RoleBinding [rbac/v1]
- RoleBinding [rbac/v1beta1]
- RoleBinding [rbac/v1alpha1]
- RuntimeClass [node/v1]
- RuntimeClass [node/v1beta1]
- RuntimeClass [node/v1alpha1]
- Scale [autoscaling/v1]
- Secret [core/v1]
- SelfSubjectAccessReview [authorization/v1]
- SelfSubjectAccessReview [authorization/v1beta1]
- SelfSubjectRulesReview [authorization/v1]
- SelfSubjectRulesReview [authorization/v1beta1]
- Service [core/v1]
- ServiceAccount [core/v1]
- StatefulSet [apps/v1]
- StorageClass [storage/v1]
- StorageClass [storage/v1beta1]
- StorageVersion [apiserverinternal/v1alpha1]
- SubjectAccessReview [authorization/v1]
- SubjectAccessReview [authorization/v1beta1]
- TokenRequest [authentication/v1]
- TokenReview [authentication/v1]
- TokenReview [authentication/v1beta1]
- ValidatingWebhookConfiguration [admissionregistration/v1]
- ValidatingWebhookConfiguration [admissionregistration/v1beta1]
- VolumeAttachment [storage/v1]
- 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/sig-architecture/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/sig-architecture/api-conventions.md#metadata
`finalizers` string array patch strategy: merge | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
`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/sig-architecture/api-conventions.md#idempotency
`generation` integer | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
`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
`managedFields` ManagedFieldsEntry array | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
`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 which 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 strategy: merge patch merge key: uid | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
`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/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`selfLink` string | SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
`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 v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `ObjectMetricSource`

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Other API versions of this object exist: v2beta1
Appears In:

- MetricSpec [autoscaling/v2beta2]

Field | Description
--- | ---
`describedObject` CrossVersionObjectReference |
`metric` MetricIdentifier | metric identifies the target metric by name and selector
`target` MetricTarget | target specifies the target value for the given metric

## ObjectMetricStatus v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `ObjectMetricStatus`

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Other API versions of this object exist: v2beta1
Appears In:

- MetricStatus [autoscaling/v2beta2]

Field | Description
--- | ---
`current` MetricValueStatus | current contains the current value for the given metric
`describedObject` CrossVersionObjectReference |
`metric` MetricIdentifier | metric identifies the target metric by name and selector

## 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/v1]
- CronJobStatus [batch/v1beta1]
- Endpoint [discovery/v1]
- Endpoint [discovery/v1beta1]
- EndpointAddress [core/v1]
- Event [core/v1]
- Event [events/v1]
- Event [events/v1beta1]
- 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/sig-architecture/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/sig-architecture/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

## Overhead v1 node.k8s.io

Group | Version | Kind
--- | --- | ---
`node.k8s.io` | `v1` | `Overhead`

Overhead structure represents the resource overhead associated with running a pod.

Other API versions of this object exist: v1beta1 v1alpha1
Appears In:

- RuntimeClass [node/v1]

Field | Description
--- | ---
`podFixed` object | PodFixed represents the fixed resource overhead associated with running a pod.

## OwnerReference v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `OwnerReference`

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

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/sig-architecture/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 |

## PersistentVolumeClaimTemplate v1 core

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

PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.

Appears In:

- EphemeralVolumeSource [core/v1]

Field | Description
--- | ---
`metadata` ObjectMeta | May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
`spec` PersistentVolumeClaimSpec | The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

## 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.
`namespaceSelector` LabelSelector | A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
`namespaces` string array | namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector 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. 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 |

## PodIP v1 core

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

IP address information for entries in the (plural) PodIPs field. Each entry includes: IP: An IP address allocated to the pod. Routable at least within the cluster.

Appears In:

- PodStatus [core/v1]

Field | Description
--- | ---
`ip` string | ip is an IP address (IPv4 or IPv6) assigned to the pod

## PodReadinessGate v1 core

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

PodReadinessGate contains the reference to a pod condition

Appears In:

- PodSpec [core/v1]

Field | Description
--- | ---
`conditionType` string | ConditionType refers to a condition in the pod's condition list with matching type.

## 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.
`fsGroupChangePolicy` string | fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
`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.
`seccompProfile` SeccompProfile | The seccomp options to use by the containers in this pod.
`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.
`sysctls` Sysctl array | Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
`windowsOptions` WindowsSecurityContextOptions | The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

## PodsMetricSource v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `PodsMetricSource`

PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.

Other API versions of this object exist: v2beta1
Appears In:

- MetricSpec [autoscaling/v2beta2]

Field | Description
--- | ---
`metric` MetricIdentifier | metric identifies the target metric by name and selector
`target` MetricTarget | target specifies the target value for the given metric

## PodsMetricStatus v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `PodsMetricStatus`

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

Other API versions of this object exist: v2beta1
Appears In:

- MetricStatus [autoscaling/v2beta2]

Field | Description
--- | ---
`current` MetricValueStatus | current contains the current value for the given metric
`metric` MetricIdentifier | metric identifies the target metric by name and selector

## PolicyRule v1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `PolicyRule`

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

Other API versions of this object exist: v1beta1 v1alpha1
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.

## PolicyRulesWithSubjects v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `PolicyRulesWithSubjects`

PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request.

Appears In:

- FlowSchemaSpec [flowcontrol/v1beta1]

Field | Description
--- | ---
`nonResourceRules` NonResourcePolicyRule array | `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL.
`resourceRules` ResourcePolicyRule array | `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty.
`subjects` Subject array | subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required.

## PortStatus v1 core

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

Appears In:

- LoadBalancerIngress [core/v1]

Field | Description
--- | ---
`error` string | Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use CamelCase names - cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.
`port` integer | Port is the port number of the service port of which status is recorded here
`protocol` string | Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"

## 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
--- | ---
`resourceVersion` string | Specifies the target ResourceVersion
`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.

## PriorityLevelConfigurationCondition v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `PriorityLevelConfigurationCondition`

PriorityLevelConfigurationCondition defines the condition of priority level.

Appears In:

- PriorityLevelConfigurationStatus [flowcontrol/v1beta1]

Field | Description
--- | ---
`lastTransitionTime` Time | `lastTransitionTime` is the last time the condition transitioned from one status to another.
`message` string | `message` is a human-readable message indicating details about last transition.
`reason` string | `reason` is a 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. Required.
`type` string | `type` is the type of the condition. Required.

## PriorityLevelConfigurationReference v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `PriorityLevelConfigurationReference`

PriorityLevelConfigurationReference contains information that points to the "request-priority" being used.

Appears In:

- FlowSchemaSpec [flowcontrol/v1beta1]

Field | Description
--- | ---
`name` string | `name` is the name of the priority level configuration being referenced Required.

## 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]
- EphemeralContainer [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 and startup. Minimum value is 1.
`tcpSocket` TCPSocketAction | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
`terminationGracePeriodSeconds` integer | Optional duration in seconds the pod needs to terminate gracefully upon probe failure. 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate.
`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 used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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`

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: <quantity> ::= <signedNumber><suffix> (Note that <suffix> may be empty, from the "" case in <decimalSI>.) <digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) <decimalSI> ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) <decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

Appears In:

- CSIStorageCapacity [storage/v1beta1]
- CSIStorageCapacity [storage/v1alpha1]
- ContainerResourceMetricSource [autoscaling/v2beta1]
- ContainerResourceMetricStatus [autoscaling/v2beta1]
- EmptyDirVolumeSource [core/v1]
- ExternalMetricSource [autoscaling/v2beta1]
- ExternalMetricStatus [autoscaling/v2beta1]
- MetricTarget [autoscaling/v2beta2]
- MetricValueStatus [autoscaling/v2beta2]
- ObjectMetricSource [autoscaling/v2beta1]
- ObjectMetricStatus [autoscaling/v2beta1]
- PodsMetricSource [autoscaling/v2beta1]
- PodsMetricStatus [autoscaling/v2beta1]
- ResourceFieldSelector [core/v1]
- ResourceMetricSource [autoscaling/v2beta1]
- ResourceMetricStatus [autoscaling/v2beta1]

Field | Description
--- | ---

## QueuingConfiguration v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `QueuingConfiguration`

QueuingConfiguration holds the configuration parameters for queuing

Appears In:

- LimitResponse [flowcontrol/v1beta1]

Field | Description
--- | ---
`handSize` integer | `handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8.
`queueLengthLimit` integer | `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50.
`queues` integer | `queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64.

## 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
`tenant` string | Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
`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://examples.k8s.io/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://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`monitors` string array | A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`pool` string | The rados pool name. Default is rbd. More info: https://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`user` string | The rados user name. Default is admin. More info: https://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`monitors` string array | A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`pool` string | The rados pool name. Default is rbd. More info: https://examples.k8s.io/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://examples.k8s.io/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://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`user` string | The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

## ReplicaSetCondition v1 apps

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

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.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `ResourceAttributes`

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

Other API versions of this object exist: v1beta1
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 v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `ResourceMetricSource`

ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

Other API versions of this object exist: v2beta1
Appears In:

- MetricSpec [autoscaling/v2beta2]

Field | Description
--- | ---
`name` string | name is the name of the resource in question.
`target` MetricTarget | target specifies the target value for the given metric

## ResourceMetricStatus v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `ResourceMetricStatus`

ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

Other API versions of this object exist: v2beta1
Appears In:

- MetricStatus [autoscaling/v2beta2]

Field | Description
--- | ---
`current` MetricValueStatus | current contains the current value for the given metric
`name` string | Name is the name of the resource in question.

## ResourcePolicyRule v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `ResourcePolicyRule`

ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request.

Appears In:

- PolicyRulesWithSubjects [flowcontrol/v1beta1]

Field | Description
--- | ---
`apiGroups` string array | `apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.
`clusterScope` boolean | `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list.
`namespaces` string array | `namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true.
`resources` string array | `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.
`verbs` string array | `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.

## ResourceRequirements v1 core

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

ResourceRequirements describes the compute resource requirements.

Appears In:

- Container [core/v1]
- EphemeralContainer [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-resources-containers/
`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-resources-containers/

## ResourceRule v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `ResourceRule`

ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.

Other API versions of this object exist: v1beta1
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.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `RoleRef`

RoleRef contains information that points to the role being used

Other API versions of this object exist: v1beta1 v1alpha1
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

## RollingUpdateStatefulSetStrategy v1 apps

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

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.

## RuleWithOperations v1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1` | `RuleWithOperations`

RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.

Other API versions of this object exist: v1beta1
Appears In:

- MutatingWebhook [admissionregistration/v1]
- ValidatingWebhook [admissionregistration/v1]

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, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. 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.
`scope` string | scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".

## RunAsGroupStrategyOptions v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `RunAsGroupStrategyOptions`

RunAsGroupStrategyOptions 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 gids that may be used. If you would like to force a single gid then supply a single range with the same start and end. Required for MustRunAs.
`rule` string | rule is the strategy that will dictate the allowable RunAsGroup values that may be set.

## RunAsUserStrategyOptions v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `RunAsUserStrategyOptions`

RunAsUserStrategyOptions 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. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs.
`rule` string | rule is the strategy that will dictate the allowable RunAsUser values that may be set.

## RuntimeClassStrategyOptions v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `RuntimeClassStrategyOptions`

RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses for a pod.

Appears In:

- PodSecurityPolicySpec [policy/v1beta1]

Field | Description
--- | ---
`allowedRuntimeClassNames` string array | allowedRuntimeClassNames is an allowlist of RuntimeClass names that may be specified on a pod. A value of "*" means that any RuntimeClass name is allowed, and must be the only item in the list. An empty list requires the RuntimeClassName field to be unset.
`defaultRuntimeClassName` string | defaultRuntimeClassName is the default RuntimeClassName to set on the pod. The default MUST be allowed by the allowedRuntimeClassNames list. A value of nil does not mutate the Pod.

## 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 [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 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `SELinuxStrategyOptions`

SELinuxStrategyOptions defines the strategy type and any options used to create the strategy.

Appears In:

- PodSecurityPolicySpec [policy/v1beta1]

Field | Description
--- | ---
`rule` string | rule 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`

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
`spec` ScaleSpec | defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
`status` ScaleStatus | current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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". Default is "xfs"
`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. Default is 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". Default is "xfs".
`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. Default is 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.

## Scheduling v1 node.k8s.io

Group | Version | Kind
--- | --- | ---
`node.k8s.io` | `v1` | `Scheduling`

Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass.

Other API versions of this object exist: v1beta1 v1alpha1
Appears In:

- RuntimeClass [node/v1]

Field | Description
--- | ---
`nodeSelector` object | nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission.
`tolerations` Toleration array | tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass.

## ScopeSelector v1 core

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

A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.

Appears In:

- ResourceQuotaSpec [core/v1]

Field | Description
--- | ---
`matchExpressions` ScopedResourceSelectorRequirement array | A list of scope selector requirements by scope of the resources.

## ScopedResourceSelectorRequirement v1 core

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

A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.

Appears In:

- ScopeSelector [core/v1]

Field | Description
--- | ---
`operator` string | Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
`scopeName` string | The name of the scope that the selector applies to.
`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. This array is replaced during a strategic merge patch.

## SeccompProfile v1 core

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

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Appears In:

- PodSecurityContext [core/v1]
- SecurityContext [core/v1]

Field | Description
--- | ---
`localhostProfile` string | localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
`type` string | type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

## 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 its 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]
- CinderPersistentVolumeSource [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 used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. 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 its 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]
- EphemeralContainer [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.
`procMount` string | procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.
`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.
`seccompProfile` SeccompProfile | The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
`windowsOptions` WindowsSecurityContextOptions | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. 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.

## ServerStorageVersion v1alpha1 internal.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`internal.apiserver.k8s.io` | `v1alpha1` | `ServerStorageVersion`

An API server instance reports the version it can decode and the version it encodes objects to when persisting objects in the backend.

Appears In:

- StorageVersionStatus [apiserverinternal/v1alpha1]

Field | Description
--- | ---
`apiServerID` string | The ID of the reporting API server.
`decodableVersions` string array | The API server can decode objects encoded in these versions. The encodingVersion must be included in the decodableVersions.
`encodingVersion` string | The API server encodes the object to this version when persisting it in the backend (e.g., etcd).

## ServiceAccountSubject v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `ServiceAccountSubject`

ServiceAccountSubject holds detailed information for service-account-kind subject.

Appears In:

- Subject [flowcontrol/v1beta1]

Field | Description
--- | ---
`name` string | `name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required.
`namespace` string | `namespace` is the namespace of matching ServiceAccount objects. Required.

## ServiceAccountTokenProjection v1 core

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

ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).

Appears In:

- VolumeProjection [core/v1]

Field | Description
--- | ---
`audience` string | Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
`expirationSeconds` integer | ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
`path` string | Path is the path relative to the mount point of the file to project the token into.

## ServiceBackendPort v1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1` | `ServiceBackendPort`

ServiceBackendPort is the service port being referenced.

Appears In:

- IngressServiceBackend [networking/v1]

Field | Description
--- | ---
`name` string | Name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
`number` integer | Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".

## ServicePort v1 core

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

ServicePort contains information on service's port.

Appears In:

- ServiceSpec [core/v1]

Field | Description
--- | ---
`appProtocol` string | The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default.
`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. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. 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 is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). 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", "UDP", and "SCTP". Default is TCP.
`targetPort` | Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service

## ServiceReference v1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1` | `ServiceReference`

ServiceReference holds a reference to Service.legacy.k8s.io

Other API versions of this object exist: v1beta1 v1beta1 v1beta1
Appears In:

- WebhookClientConfig [admissionregistration/v1]

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.
`port` integer | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).

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

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`

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.

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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/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.

## StorageVersionCondition v1alpha1 internal.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`internal.apiserver.k8s.io` | `v1alpha1` | `StorageVersionCondition`

Describes the state of the storageVersion at a certain point.

Appears In:

- StorageVersionStatus [apiserverinternal/v1alpha1]

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.
`observedGeneration` integer | If set, this represents the .metadata.generation that the condition was set based upon.
`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 the condition.

## Subject v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `Subject`

Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account.

Other API versions of this object exist: v1 v1alpha1
Appears In:

- PolicyRulesWithSubjects [flowcontrol/v1beta1]

Field | Description
--- | ---
`group` GroupSubject |
`kind` string | Required
`serviceAccount` ServiceAccountSubject |
`user` UserSubject |

## SubjectRulesReviewStatus v1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1` | `SubjectRulesReviewStatus`

SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.

Other API versions of this object exist: v1beta1
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 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. Required for MustRunAs.
`rule` string | rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.

## Sysctl v1 core

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

Sysctl defines a kernel parameter to be set

Appears In:

- PodSecurityContext [core/v1]

Field | Description
--- | ---
`name` string | Name of a property to set
`value` string | Value of a property to set

## 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 | The taint value corresponding to the taint key.

## Time v1 meta

Group | Version | Kind
--- | --- | ---
`meta` | `v1` | `Time`

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

Appears In:

- APIServiceCondition [apiregistration/v1]
- APIServiceCondition [apiregistration/v1beta1]
- CertificateSigningRequestCondition [certificates/v1]
- CertificateSigningRequestCondition [certificates/v1beta1]
- Condition [meta/v1]
- ContainerStateRunning [core/v1]
- ContainerStateTerminated [core/v1]
- CronJobStatus [batch/v1]
- CronJobStatus [batch/v1beta1]
- CustomResourceDefinitionCondition [apiextensions/v1]
- CustomResourceDefinitionCondition [apiextensions/v1beta1]
- DaemonSetCondition [apps/v1]
- DeploymentCondition [apps/v1]
- Event [core/v1]
- Event [events/v1]
- Event [events/v1beta1]
- FlowSchemaCondition [flowcontrol/v1beta1]
- HorizontalPodAutoscalerCondition [autoscaling/v2beta2]
- HorizontalPodAutoscalerCondition [autoscaling/v2beta1]
- HorizontalPodAutoscalerStatus [autoscaling/v1]
- HorizontalPodAutoscalerStatus [autoscaling/v2beta2]
- HorizontalPodAutoscalerStatus [autoscaling/v2beta1]
- JobCondition [batch/v1]
- JobStatus [batch/v1]
- ManagedFieldsEntry [meta/v1]
- NamespaceCondition [core/v1]
- NodeCondition [core/v1]
- ObjectMeta [meta/v1]
- PersistentVolumeClaimCondition [core/v1]
- PodCondition [core/v1]
- PodStatus [core/v1]
- PriorityLevelConfigurationCondition [flowcontrol/v1beta1]
- ReplicaSetCondition [apps/v1]
- ReplicationControllerCondition [core/v1]
- StatefulSetCondition [apps/v1]
- StorageVersionCondition [apiserverinternal/v1alpha1]
- Taint [core/v1]
- TokenRequestStatus [authentication/v1]
- VolumeError [storage/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]
- Scheduling [node/v1]
- Scheduling [node/v1beta1]
- Scheduling [node/v1alpha1]

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.

## TopologySelectorLabelRequirement v1 core

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

A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

Appears In:

- TopologySelectorTerm [core/v1]

Field | Description
--- | ---
`key` string | The label key that the selector applies to.
`values` string array | An array of string values. One value must match the label to be selected. Each entry in Values is ORed.

## TopologySelectorTerm v1 core

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

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

Appears In:

- StorageClass [storage/v1]
- StorageClass [storage/v1beta1]

Field | Description
--- | ---
`matchLabelExpressions` TopologySelectorLabelRequirement array | A list of topology selector requirements by labels.

## TopologySpreadConstraint v1 core

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

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

Appears In:

- PodSpec [core/v1]

Field | Description
--- | ---
`labelSelector` LabelSelector | LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
`maxSkew` integer | MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.
`topologyKey` string | TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.
`whenUnsatisfiable` string | WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.

## TypedLocalObjectReference v1 core

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

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

Appears In:

- IngressBackend [networking/v1]
- IngressBackend [extensions/v1beta1]
- IngressBackend [networking/v1beta1]
- PersistentVolumeClaimSpec [core/v1]

Field | Description
--- | ---
`apiGroup` string | APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
`kind` string | Kind is the type of resource being referenced
`name` string | Name is the name of resource being referenced

## UserInfo v1 authentication.k8s.io

Group | Version | Kind
--- | --- | ---
`authentication.k8s.io` | `v1` | `UserInfo`

UserInfo holds the information about the user needed to implement the user.Info interface.

Other API versions of this object exist: v1beta1
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.

## UserSubject v1beta1 flowcontrol.apiserver.k8s.io

Group | Version | Kind
--- | --- | ---
`flowcontrol.apiserver.k8s.io` | `v1beta1` | `UserSubject`

UserSubject holds detailed information for user-kind subject.

Appears In:

- Subject [flowcontrol/v1beta1]

Field | Description
--- | ---
`name` string | `name` is the username that matches, or "*" to match all usernames. Required.

## ValidatingWebhook v1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1` | `ValidatingWebhook`

ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

Other API versions of this object exist: v1beta1
Appears In:

- ValidatingWebhookConfiguration [admissionregistration/v1]

Field | Description
--- | ---
`admissionReviewVersions` string array | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy.
`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 Fail.
`matchPolicy` string | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Equivalent"
`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.
`objectSelector` LabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. 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.
`sideEffects` string | SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.
`timeoutSeconds` integer | TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds.

## VolumeAttachmentSource v1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1` | `VolumeAttachmentSource`

VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.

Other API versions of this object exist: v1beta1 v1alpha1
Appears In:

- VolumeAttachmentSpec [storage/v1]

Field | Description
--- | ---
`inlineVolumeSpec` PersistentVolumeSpec | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature.
`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]
- EphemeralContainer [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 v1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1` | `VolumeError`

VolumeError captures an error encountered during a volume operation.

Other API versions of this object exist: v1beta1 v1alpha1
Appears In:

- VolumeAttachmentStatus [storage/v1]

Field | Description
--- | ---
`message` string | String detailing the error encountered during Attach or Detach operation. This string may be 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]
- EphemeralContainer [core/v1]

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, MountPropagationNone 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).
`subPathExpr` string | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

## 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.

## VolumeNodeResources v1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1` | `VolumeNodeResources`

VolumeNodeResources is a set of resource limits for scheduling of volumes.

Other API versions of this object exist: v1beta1
Appears In:

- CSINodeDriver [storage/v1]

Field | Description
--- | ---
`count` integer | Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded.

## 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
`serviceAccountToken` ServiceAccountTokenProjection | information about the serviceAccountToken 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 |

## WebhookClientConfig v1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1` | `WebhookClientConfig`

WebhookClientConfig contains the information to make a TLS connection with the webhook

Other API versions of this object exist: v1beta1 v1beta1
Appears In:

- MutatingWebhook [admissionregistration/v1]
- ValidatingWebhook [admissionregistration/v1]

Field | Description
--- | ---
`caBundle` string | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
`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`.
`url` string | `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.

## WebhookConversion v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `WebhookConversion`

WebhookConversion describes how to call a conversion webhook

Appears In:

- CustomResourceConversion [apiextensions/v1]

Field | Description
--- | ---
`clientConfig` WebhookClientConfig | clientConfig is the instructions for how to call the webhook if strategy is `Webhook`.
`conversionReviewVersions` string array | conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail.

## 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.

## WindowsSecurityContextOptions v1 core

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

WindowsSecurityContextOptions contain Windows-specific options and credentials.

Appears In:

- PodSecurityContext [core/v1]
- SecurityContext [core/v1]

Field | Description
--- | ---
`gmsaCredentialSpec` string | GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
`gmsaCredentialSpecName` string | GMSACredentialSpecName is the name of the GMSA credential spec to use.
`runAsUserName` string | The UserName in Windows to run the entrypoint of the container process. Defaults to the 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.

# 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
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/sig-architecture/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/sig-architecture/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. If unspecified, system trust roots on the apiserver are used.
`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). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.

### APIServiceStatus v1beta1 apiregistration

Appears In:

- APIService [apiregistration/v1beta1]

Field | Description
--- | ---
`conditions` APIServiceCondition array patch strategy: 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta |

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 APIService | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` APIService |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 APIService | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the APIService

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified APIService

### HTTP Request

`PATCH /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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 APIService | OK

## Read Status

read status of the specified APIService

### HTTP Request

`GET /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.

### Response

Code | Description
--- | ---
200 APIService | OK

## Replace Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

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

# CSIDriver v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `CSIDriver`

Other API versions of this object exist: v1
Appears In:

- CSIDriverList [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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` CSIDriverSpec | Specification of the CSI Driver.

### CSIDriverSpec v1beta1 storage

Appears In:

- CSIDriver [storage/v1beta1]

Field | Description
--- | ---
`attachRequired` boolean | attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. This field is immutable.
`fsGroupPolicy` string | Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate. This field is immutable.
`podInfoOnMount` boolean | If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false" "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. This field is immutable.
`requiresRepublish` boolean | RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false. Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.
`storageCapacity` boolean | If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. This field is immutable. This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false.
`tokenRequests` TokenRequest array | TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { "<audience>": { "token": <token>, "expirationTimestamp": <expiration timestamp in RFC3339>, }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.
`volumeLifecycleModes` string array | VolumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is immutable.

### CSIDriverList 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/sig-architecture/api-conventions.md#resources
`items` CSIDriver array | items is the list of CSIDriver
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a CSIDriver

### HTTP Request

`POST /apis/storage.k8s.io/v1beta1/csidrivers`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSIDriver |

### Response

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

## Patch

partially update the specified CSIDriver

### HTTP Request

`PATCH /apis/storage.k8s.io/v1beta1/csidrivers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIDriver

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CSIDriver | OK

## Replace

replace the specified CSIDriver

### HTTP Request

`PUT /apis/storage.k8s.io/v1beta1/csidrivers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIDriver

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSIDriver |

### Response

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

## Delete

delete a CSIDriver

### HTTP Request

`DELETE /apis/storage.k8s.io/v1beta1/csidrivers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIDriver

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CSIDriver | OK
202 CSIDriver | Accepted

## Delete Collection

delete collection of CSIDriver

### HTTP Request

`DELETE /apis/storage.k8s.io/v1beta1/csidrivers`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified CSIDriver

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/csidrivers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIDriver

### Query Parameters

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

### Response

Code | Description
--- | ---
200 CSIDriver | OK

## List

list or watch objects of kind CSIDriver

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/csidrivers`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CSIDriverList | OK

## Watch

watch changes to an object of kind CSIDriver. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/csidrivers/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIDriver

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CSIDriver. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/csidrivers`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# CSINode v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `CSINode`

Other API versions of this object exist: v1
Appears In:

- CSINodeList [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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | metadata.name must be the Kubernetes node name.
`spec` CSINodeSpec | spec is the specification of CSINode

### CSINodeSpec v1beta1 storage

Appears In:

- CSINode [storage/v1beta1]

Field | Description
--- | ---
`drivers` CSINodeDriver array patch strategy: merge patch merge key: name | drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty.

### CSINodeList 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/sig-architecture/api-conventions.md#resources
`items` CSINode array | items is the list of CSINode
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a CSINode

### HTTP Request

`POST /apis/storage.k8s.io/v1beta1/csinodes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSINode |

### Response

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

## Patch

partially update the specified CSINode

### HTTP Request

`PATCH /apis/storage.k8s.io/v1beta1/csinodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSINode

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CSINode | OK

## Replace

replace the specified CSINode

### HTTP Request

`PUT /apis/storage.k8s.io/v1beta1/csinodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSINode

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSINode |

### Response

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

## Delete

delete a CSINode

### HTTP Request

`DELETE /apis/storage.k8s.io/v1beta1/csinodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSINode

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CSINode | OK
202 CSINode | Accepted

## Delete Collection

delete collection of CSINode

### HTTP Request

`DELETE /apis/storage.k8s.io/v1beta1/csinodes`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified CSINode

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/csinodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSINode

### Query Parameters

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

### Response

Code | Description
--- | ---
200 CSINode | OK

## List

list or watch objects of kind CSINode

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/csinodes`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CSINodeList | OK

## Watch

watch changes to an object of kind CSINode. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/csinodes/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSINode

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CSINode. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/csinodes`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# CSINodeDriver v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `CSINodeDriver`

Other API versions of this object exist: v1
Appears In:

- CSINodeSpec [storage/v1beta1]

Field | Description
--- | ---
`allocatable` VolumeNodeResources | allocatable represents the volume resources of a node that are available for scheduling.
`name` string | This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.
`nodeID` string | nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.
`topologyKeys` string array | topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.

# CSIStorageCapacity v1alpha1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1alpha1` | `CSIStorageCapacity`

Other API versions of this object exist: v1beta1
Appears In:

- CSIStorageCapacityList [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/sig-architecture/api-conventions.md#resources
`capacity` Quantity | Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity.
`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/sig-architecture/api-conventions.md#types-kinds
`maximumVolumeSize` Quantity | MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.
`metadata` ObjectMeta | Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name. Objects are namespaced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`nodeTopology` LabelSelector | NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.
`storageClassName` string | The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.

### CSIStorageCapacityList 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/sig-architecture/api-conventions.md#resources
`items` CSIStorageCapacity array | Items is the list of CSIStorageCapacity 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a CSIStorageCapacity

### HTTP Request

`POST /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities`

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSIStorageCapacity |

### Response

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

## Patch

partially update the specified CSIStorageCapacity

### HTTP Request

`PATCH /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CSIStorageCapacity | OK

## Replace

replace the specified CSIStorageCapacity

### HTTP Request

`PUT /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CSIStorageCapacity |

### Response

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

## Delete

delete a CSIStorageCapacity

### HTTP Request

`DELETE /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities/{name}`

### Path Parameters

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

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of CSIStorageCapacity

### HTTP Request

`DELETE /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified CSIStorageCapacity

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CSIStorageCapacity
`namespace` | 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 CSIStorageCapacity | OK

## List

list or watch objects of kind CSIStorageCapacity

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities`

### 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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CSIStorageCapacityList | OK

## List All Namespaces

list or watch objects of kind CSIStorageCapacity

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/csistoragecapacities`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 CSIStorageCapacityList | OK

## Watch

watch changes to an object of kind CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/watch/namespaces/{namespace}/csistoragecapacities/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/watch/namespaces/{namespace}/csistoragecapacities`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/watch/csistoragecapacities`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# CertificateSigningRequest v1beta1 certificates.k8s.io

Group | Version | Kind
--- | --- | ---
`certificates.k8s.io` | `v1beta1` | `CertificateSigningRequest`

Other API versions of this object exist: v1
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/sig-architecture/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/sig-architecture/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
`signerName` string | Requested signer for the request. It is a qualified name in the form: `scope-hostname.io/name`. If empty, it will be defaulted: 1. If it's a kubelet client certificate, it is assigned "kubernetes.io/kube-apiserver-client-kubelet". 2. If it's a kubelet serving certificate, it is assigned "kubernetes.io/kubelet-serving". 3. Otherwise, it is assigned "kubernetes.io/legacy-unknown". Distribution of trust for signers happens out of band. You can select on this field using `spec.signerName`.
`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 Valid values are: "signing", "digital signature", "content commitment", "key encipherment", "key agreement", "data encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "email protection", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc"
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta |

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CertificateSigningRequest |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CertificateSigningRequest |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CertificateSigningRequest

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified CertificateSigningRequest

### HTTP Request

`PATCH /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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK

## Read Status

read status of the specified CertificateSigningRequest

### HTTP Request

`GET /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.

### Response

Code | Description
--- | ---
200 CertificateSigningRequest | OK

## Replace Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CertificateSigningRequest |

### Response

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

# CertificateSigningRequestCondition v1beta1 certificates.k8s.io

Group | Version | Kind
--- | --- | ---
`certificates.k8s.io` | `v1beta1` | `CertificateSigningRequestCondition`

Other API versions of this object exist: v1
Appears In:

- CertificateSigningRequestStatus [certificates/v1beta1]

Field | Description
--- | ---
`lastTransitionTime` Time | lastTransitionTime is the time the condition last transitioned from one status to another. If unset, when a new condition type is added or an existing condition's status is changed, the server defaults this to the current time.
`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
`status` string | Status of the condition, one of True, False, Unknown. Approved, Denied, and Failed conditions may not be "False" or "Unknown". Defaults to "True". If unset, should be treated as "True".
`type` string | type of the condition. Known conditions include "Approved", "Denied", and "Failed".

# ClusterRole v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `ClusterRole`

Other API versions of this object exist: v1 v1alpha1
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ClusterRole | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ClusterRole | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRole |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ClusterRoleBinding | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ClusterRoleBinding |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# ContainerResourceMetricSource v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `ContainerResourceMetricSource`

Other API versions of this object exist: v2beta2
Appears In:

- MetricSpec [autoscaling/v2beta1]

Field | Description
--- | ---
`container` string | container is the name of the container in the pods of the scaling target
`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.

# ContainerResourceMetricStatus v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `ContainerResourceMetricStatus`

Other API versions of this object exist: v2beta2
Appears In:

- MetricStatus [autoscaling/v2beta1]

Field | Description
--- | ---
`container` string | container is the name of the container in the pods of the scaling target
`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.

# CronJob v1beta1 batch

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

Other API versions of this object exist: v1
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#spec-and-status
`status` CronJobStatus | Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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.
`lastSuccessfulTime` Time | Information when was the last time the job successfully completed.

### 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

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

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind CronJob

### HTTP Request

`GET /apis/batch/v1beta1/cronjobs`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

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

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

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

### Response

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

# CrossVersionObjectReference v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `CrossVersionObjectReference`

Other API versions of this object exist: v1 v2beta1
Appears In:

- HorizontalPodAutoscalerSpec [autoscaling/v2beta2]
- ObjectMetricSource [autoscaling/v2beta2]
- ObjectMetricStatus [autoscaling/v2beta2]

Field | Description
--- | ---
`apiVersion` string | API version of the referent
`kind` string | Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
`name` string | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

# CrossVersionObjectReference v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `CrossVersionObjectReference`

Other API versions of this object exist: v1 v2beta2
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/sig-architecture/api-conventions.md#types-kinds"
`name` string | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

# CustomResourceColumnDefinition v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceColumnDefinition`

Other API versions of this object exist: v1
Appears In:

- CustomResourceDefinitionSpec [apiextensions/v1beta1]
- CustomResourceDefinitionVersion [apiextensions/v1beta1]

Field | Description
--- | ---
`JSONPath` string | JSONPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.
`description` string | description is a human readable description of this column.
`format` string | format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
`name` string | name is a human readable name for the column.
`priority` integer | priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0.
`type` string | type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.

# CustomResourceConversion v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceConversion`

Other API versions of this object exist: v1
Appears In:

- CustomResourceDefinitionSpec [apiextensions/v1beta1]

Field | Description
--- | ---
`conversionReviewVersions` string array | conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. Defaults to `["v1beta1"]`.
`strategy` string | strategy specifies how custom resources are converted between versions. Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhookClientConfig to be set.
`webhookClientConfig` WebhookClientConfig | webhookClientConfig is the instructions for how to call the webhook if strategy is `Webhook`. Required when `strategy` is set to `Webhook`.

# CustomResourceDefinition v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceDefinition`

Other API versions of this object exist: v1
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/sig-architecture/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/sig-architecture/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
--- | ---
`additionalPrinterColumns` CustomResourceColumnDefinition array | additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If present, this field configures columns for all versions. Top-level and per-version columns are mutually exclusive. If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.
`conversion` CustomResourceConversion | conversion defines conversion settings for the CRD.
`group` string | group is the API group of the defined custom resource. The custom resources are served under `/apis/<group>/...`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`).
`names` CustomResourceDefinitionNames | names specify the resource and kind names for the custom resource.
`preserveUnknownFields` boolean | preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. If false, schemas must be defined for all versions. Defaults to true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the `x-kubernetes-preserve-unknown-fields: true` extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
`scope` string | scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. Default is `Namespaced`.
`subresources` CustomResourceSubresources | subresources specify what subresources the defined custom resource has. If present, this field configures subresources for all versions. Top-level and per-version subresources are mutually exclusive.
`validation` CustomResourceValidation | validation describes the schema used for validation and pruning of the custom resource. If present, this validation schema is used to validate all versions. Top-level and per-version schemas are mutually exclusive.
`version` string | version is the API version of the defined custom resource. The custom resources are served under `/apis/<group>/<version>/...`. Must match the name of the first item in the `versions` list if `version` and `versions` are both specified. Optional if `versions` is specified. Deprecated: use `versions` instead.
`versions` CustomResourceDefinitionVersion array | versions is the list of all API versions of the defined custom resource. Optional if `version` is specified. The name of the first item in the `versions` list must match the `version` field if `version` and `versions` are both specified. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.

### 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
`storedVersions` string array | storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from `spec.versions` while they exist in this list.

### 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/sig-architecture/api-conventions.md#resources
`items` CustomResourceDefinition array | items list individual CustomResourceDefinition 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta |

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CustomResourceDefinition |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CustomResourceDefinition |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the CustomResourceDefinition

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified CustomResourceDefinition

### HTTP Request

`PATCH /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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK

## Read Status

read status of the specified CustomResourceDefinition

### HTTP Request

`GET /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.

### Response

Code | Description
--- | ---
200 CustomResourceDefinition | OK

## Replace Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` CustomResourceDefinition |

### Response

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

# CustomResourceDefinitionCondition v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceDefinitionCondition`

Other API versions of this object exist: v1
Appears In:

- CustomResourceDefinitionStatus [apiextensions/v1beta1]

Field | Description
--- | ---
`lastTransitionTime` Time | lastTransitionTime last time the condition transitioned from one status to another.
`message` string | message is a human-readable message indicating details about last transition.
`reason` string | reason is a 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. Types include Established, NamesAccepted and Terminating.

# CustomResourceDefinitionNames v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceDefinitionNames`

Other API versions of this object exist: v1
Appears In:

- CustomResourceDefinitionSpec [apiextensions/v1beta1]
- CustomResourceDefinitionStatus [apiextensions/v1beta1]

Field | Description
--- | ---
`categories` string array | categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.
`kind` string | kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.
`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. The custom resources are served under `/apis/<group>/<version>/.../<plural>`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). Must be all lowercase.
`shortNames` string array | shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get <shortname>`. It must be all lowercase.
`singular` string | singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.

# CustomResourceDefinitionVersion v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceDefinitionVersion`

Other API versions of this object exist: v1
Appears In:

- CustomResourceDefinitionSpec [apiextensions/v1beta1]

Field | Description
--- | ---
`additionalPrinterColumns` CustomResourceColumnDefinition array | additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. Top-level and per-version columns are mutually exclusive. Per-version columns must not all be set to identical values (top-level columns should be used instead). If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.
`deprecated` boolean | deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
`deprecationWarning` string | deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists.
`name` string | name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis/<group>/<version>/...` if `served` is true.
`schema` CustomResourceValidation | schema describes the schema used for validation and pruning of this version of the custom resource. Top-level and per-version schemas are mutually exclusive. Per-version schemas must not all be set to identical values (top-level validation schema should be used instead).
`served` boolean | served is a flag enabling/disabling this version from being served via REST APIs
`storage` boolean | storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
`subresources` CustomResourceSubresources | subresources specify what subresources this version of the defined custom resource have. Top-level and per-version subresources are mutually exclusive. Per-version subresources must not all be set to identical values (top-level subresources should be used instead).

# CustomResourceSubresourceScale v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceSubresourceScale`

Other API versions of this object exist: v1
Appears In:

- CustomResourceSubresources [apiextensions/v1beta1]

Field | Description
--- | ---
`labelSelectorPath` string | labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string.
`specReplicasPath` string | specReplicasPath defines the JSON path inside of a custom resource 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 custom resource, the `/scale` subresource will return an error on GET.
`statusReplicasPath` string | statusReplicasPath defines the JSON path inside of a custom resource 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 custom resource, the `status.replicas` value in the `/scale` subresource will default to 0.

# CustomResourceSubresourceStatus v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceSubresourceStatus`

Other API versions of this object exist: v1
Appears In:

- CustomResourceSubresources [apiextensions/v1beta1]

Field | Description
--- | ---

# CustomResourceSubresources v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceSubresources`

Other API versions of this object exist: v1
Appears In:

- CustomResourceDefinitionSpec [apiextensions/v1beta1]
- CustomResourceDefinitionVersion [apiextensions/v1beta1]

Field | Description
--- | ---
`scale` CustomResourceSubresourceScale | scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object.
`status` CustomResourceSubresourceStatus | status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object.

# CustomResourceValidation v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `CustomResourceValidation`

Other API versions of this object exist: v1
Appears In:

- CustomResourceDefinitionSpec [apiextensions/v1beta1]
- CustomResourceDefinitionVersion [apiextensions/v1beta1]

Field | Description
--- | ---
`openAPIV3Schema` JSONSchemaProps | openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.

# Endpoint v1beta1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1beta1` | `Endpoint`

Other API versions of this object exist: v1
Appears In:

- EndpointSlice [discovery/v1beta1]

Field | Description
--- | ---
`addresses` string array | addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100.
`conditions` EndpointConditions | conditions contains information about the current status of the endpoint.
`hints` EndpointHints | hints contains information associated with how an endpoint should be consumed.
`hostname` string | hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.
`nodeName` string | nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate.
`targetRef` ObjectReference | targetRef is a reference to a Kubernetes object that represents this endpoint.
`topology` object | topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node where the endpoint is located. This should match the corresponding node label. * topology.kubernetes.io/zone: the value indicates the zone where the endpoint is located. This should match the corresponding node label. * topology.kubernetes.io/region: the value indicates the region where the endpoint is located. This should match the corresponding node label. This field is deprecated and will be removed in future api versions.

# EndpointConditions v1beta1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1beta1` | `EndpointConditions`

Other API versions of this object exist: v1
Appears In:

- Endpoint [discovery/v1beta1]

Field | Description
--- | ---
`ready` boolean | ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints.
`serving` boolean | serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
`terminating` boolean | terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.

# EndpointHints v1beta1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1beta1` | `EndpointHints`

Other API versions of this object exist: v1
Appears In:

- Endpoint [discovery/v1beta1]

Field | Description
--- | ---
`forZones` ForZone array | forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. May contain a maximum of 8 entries.

# EndpointPort v1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1` | `EndpointPort`

Other API versions of this object exist: v1beta1
Appears In:

- EndpointSlice [discovery/v1]

Field | Description
--- | ---
`appProtocol` string | The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
`name` string | The name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.
`port` integer | The port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.
`protocol` string | The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

# EndpointPort v1beta1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1beta1` | `EndpointPort`

Other API versions of this object exist: v1 v1
Appears In:

- EndpointSlice [discovery/v1beta1]

Field | Description
--- | ---
`appProtocol` string | The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
`name` string | The name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.
`port` integer | The port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.
`protocol` string | The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

# EndpointSlice v1beta1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1beta1` | `EndpointSlice`

Other API versions of this object exist: v1
Appears In:

- EndpointSliceList [discovery/v1beta1]

Field | Description
--- | ---
`addressType` string | addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name.
`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/sig-architecture/api-conventions.md#resources
`endpoints` Endpoint array | endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata.
`ports` EndpointPort array | ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports.

### EndpointSliceList v1beta1 discovery

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/sig-architecture/api-conventions.md#resources
`items` EndpointSlice array | List of endpoint slices
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata.

## Write Operations

## Create

create an EndpointSlice

### HTTP Request

`POST /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices`

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` EndpointSlice |

### Response

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

## Patch

partially update the specified EndpointSlice

### HTTP Request

`PATCH /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 EndpointSlice | OK

## Replace

replace the specified EndpointSlice

### HTTP Request

`PUT /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` EndpointSlice |

### Response

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

## Delete

delete an EndpointSlice

### HTTP Request

`DELETE /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}`

### Path Parameters

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

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of EndpointSlice

### HTTP Request

`DELETE /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified EndpointSlice

### HTTP Request

`GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the EndpointSlice
`namespace` | 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 EndpointSlice | OK

## List

list or watch objects of kind EndpointSlice

### HTTP Request

`GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices`

### 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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 EndpointSliceList | OK

## List All Namespaces

list or watch objects of kind EndpointSlice

### HTTP Request

`GET /apis/discovery.k8s.io/v1beta1/endpointslices`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 EndpointSliceList | OK

## Watch

watch changes to an object of kind EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/discovery.k8s.io/v1beta1/watch/namespaces/{namespace}/endpointslices/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/discovery.k8s.io/v1beta1/watch/namespaces/{namespace}/endpointslices`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/discovery.k8s.io/v1beta1/watch/endpointslices`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# Event v1 core

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

Other API versions of this object exist: v1beta1
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Event |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Event | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Event |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 Event | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Event

### HTTP Request

`GET /api/v1/events`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /api/v1/watch/events`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# Event v1beta1 events.k8s.io

Group | Version | Kind
--- | --- | ---
`events.k8s.io` | `v1beta1` | `Event`

Other API versions of this object exist: v1 v1
Appears In:

- EventList [events/v1beta1]

Field | Description
--- | ---
`action` string | action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field can have at most 128 characters.
`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/sig-architecture/api-conventions.md#resources
`deprecatedCount` integer | deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.
`deprecatedFirstTimestamp` Time | deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
`deprecatedLastTimestamp` Time | deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
`deprecatedSource` EventSource | deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.
`eventTime` MicroTime | eventTime is the time when this Event was first observed. It is required.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`note` string | note is 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 | reason is why the action was taken. It is human-readable. This field can have at most 128 characters.
`regarding` ObjectReference | regarding contains 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 | related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.
`reportingController` string | reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events.
`reportingInstance` string | reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters.
`series` EventSeries | series is data about the Event series this event represents or nil if it's a singleton Event.
`type` string | type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable.

### 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Event |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Event | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Event |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 Event | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Event

### HTTP Request

`GET /apis/events.k8s.io/v1beta1/events`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/events.k8s.io/v1beta1/watch/events`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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 v1 core

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

Other API versions of this object exist: v1beta1
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

# EventSeries v1beta1 events.k8s.io

Group | Version | Kind
--- | --- | ---
`events.k8s.io` | `v1beta1` | `EventSeries`

Other API versions of this object exist: v1 v1
Appears In:

- Event [events/v1beta1]

Field | Description
--- | ---
`count` integer | count is the number of occurrences in this series up to the last heartbeat time.
`lastObservedTime` MicroTime | lastObservedTime is the time when last Event from the series was seen before last heartbeat.

# ExternalDocumentation v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `ExternalDocumentation`

Other API versions of this object exist: v1
Appears In:

- JSONSchemaProps [apiextensions/v1beta1]

Field | Description
--- | ---
`description` string |
`url` string |

# ExternalMetricSource v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `ExternalMetricSource`

Other API versions of this object exist: v2beta2
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`

Other API versions of this object exist: v2beta2
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.

# ForZone v1beta1 discovery.k8s.io

Group | Version | Kind
--- | --- | ---
`discovery.k8s.io` | `v1beta1` | `ForZone`

Other API versions of this object exist: v1
Appears In:

- EndpointHints [discovery/v1beta1]

Field | Description
--- | ---
`name` string | name represents the name of the zone.

# HTTPIngressPath v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `HTTPIngressPath`

Other API versions of this object exist: v1
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 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 '/'. When unspecified, all paths from incoming requests are matched.
`pathType` string | PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types. Defaults to ImplementationSpecific.

# HTTPIngressPath v1beta1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1beta1` | `HTTPIngressPath`

Other API versions of this object exist: v1
Appears In:

- HTTPIngressRuleValue [networking/v1beta1]

Field | Description
--- | ---
`backend` IngressBackend | Backend defines the referenced service endpoint to which the traffic will be forwarded to.
`path` string | Path is 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 '/'. When unspecified, all paths from incoming requests are matched.
`pathType` string | PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types. Defaults to ImplementationSpecific.

# HTTPIngressRuleValue v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `HTTPIngressRuleValue`

Other API versions of this object exist: v1
Appears In:

- IngressRule [extensions/v1beta1]

Field | Description
--- | ---
`paths` HTTPIngressPath array | A collection of paths that map requests to backends.

# HTTPIngressRuleValue v1beta1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1beta1` | `HTTPIngressRuleValue`

Other API versions of this object exist: v1
Appears In:

- IngressRule [networking/v1beta1]

Field | Description
--- | ---
`paths` HTTPIngressPath array | A collection of paths that map requests to backends.

# HorizontalPodAutoscaler v2beta2 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta2` | `HorizontalPodAutoscaler`

Other API versions of this object exist: v1 v2beta1
Appears In:

- HorizontalPodAutoscalerList [autoscaling/v2beta2]

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#spec-and-status.
`status` HorizontalPodAutoscalerStatus | status is the current information about the autoscaler.

### HorizontalPodAutoscalerSpec v2beta2 autoscaling

Appears In:

- HorizontalPodAutoscaler [autoscaling/v2beta2]

Field | Description
--- | ---
`behavior` HorizontalPodAutoscalerBehavior | behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.
`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. If not set, the default metric will be set to 80% average CPU utilization.
`minReplicas` integer | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
`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 v2beta2 autoscaling

Appears In:

- HorizontalPodAutoscaler [autoscaling/v2beta2]

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 v2beta2 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | metadata is the standard list metadata.

## Write Operations

## Create

create a HorizontalPodAutoscaler

### HTTP Request

`POST /apis/autoscaling/v2beta2/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

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

## Patch

partially update the specified HorizontalPodAutoscaler

### HTTP Request

`PATCH /apis/autoscaling/v2beta2/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Replace

replace the specified HorizontalPodAutoscaler

### HTTP Request

`PUT /apis/autoscaling/v2beta2/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

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

## Delete

delete a HorizontalPodAutoscaler

### HTTP Request

`DELETE /apis/autoscaling/v2beta2/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of HorizontalPodAutoscaler

### HTTP Request

`DELETE /apis/autoscaling/v2beta2/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta2/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.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## List

list or watch objects of kind HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta2/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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta2/horizontalpodautoscalers`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/autoscaling/v2beta2/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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/autoscaling/v2beta2/watch/namespaces/{namespace}/horizontalpodautoscalers`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/autoscaling/v2beta2/watch/horizontalpodautoscalers`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified HorizontalPodAutoscaler

### HTTP Request

`PATCH /apis/autoscaling/v2beta2/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Read Status

read status of the specified HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta2/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

replace status of the specified HorizontalPodAutoscaler

### HTTP Request

`PUT /apis/autoscaling/v2beta2/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

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

# HorizontalPodAutoscaler v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `HorizontalPodAutoscaler`

Other API versions of this object exist: v1 v2beta2
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | metadata is the standard list metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind HorizontalPodAutoscaler

### HTTP Request

`GET /apis/autoscaling/v2beta1/horizontalpodautoscalers`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 HorizontalPodAutoscaler | OK

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` HorizontalPodAutoscaler |

### Response

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

# HorizontalPodAutoscalerCondition v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `HorizontalPodAutoscalerCondition`

Other API versions of this object exist: v2beta2
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

# Ingress v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `Ingress`

Other API versions of this object exist: v1
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` IngressSpec | Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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.
`ingressClassName` string | IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Ingress | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 Ingress | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Ingress

### HTTP Request

`GET /apis/extensions/v1beta1/ingresses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/extensions/v1beta1/watch/ingresses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Ingress | OK

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

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

# Ingress v1beta1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1beta1` | `Ingress`

Other API versions of this object exist: v1
Appears In:

- IngressList [networking/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` IngressSpec | Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#spec-and-status

### IngressSpec v1beta1 networking

Appears In:

- Ingress [networking/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.
`ingressClassName` string | IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.
`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 networking

Appears In:

- Ingress [networking/v1beta1]

Field | Description
--- | ---
`loadBalancer` LoadBalancerStatus | LoadBalancer contains the current status of the load-balancer.

### IngressList v1beta1 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create an Ingress

### HTTP Request

`POST /apis/networking.k8s.io/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

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

## Patch

partially update the specified Ingress

### HTTP Request

`PATCH /apis/networking.k8s.io/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Ingress | OK

## Replace

replace the specified Ingress

### HTTP Request

`PUT /apis/networking.k8s.io/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

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

## Delete

delete an Ingress

### HTTP Request

`DELETE /apis/networking.k8s.io/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of Ingress

### HTTP Request

`DELETE /apis/networking.k8s.io/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified Ingress

### HTTP Request

`GET /apis/networking.k8s.io/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.

### Response

Code | Description
--- | ---
200 Ingress | OK

## List

list or watch objects of kind Ingress

### HTTP Request

`GET /apis/networking.k8s.io/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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Ingress

### HTTP Request

`GET /apis/networking.k8s.io/v1beta1/ingresses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/networking.k8s.io/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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/networking.k8s.io/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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/networking.k8s.io/v1beta1/watch/ingresses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

partially update status of the specified Ingress

### HTTP Request

`PATCH /apis/networking.k8s.io/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Ingress | OK

## Read Status

read status of the specified Ingress

### HTTP Request

`GET /apis/networking.k8s.io/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

replace status of the specified Ingress

### HTTP Request

`PUT /apis/networking.k8s.io/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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Ingress |

### Response

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

# IngressBackend v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `IngressBackend`

Other API versions of this object exist: v1
Appears In:

- HTTPIngressPath [extensions/v1beta1]
- IngressSpec [extensions/v1beta1]

Field | Description
--- | ---
`resource` TypedLocalObjectReference | Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.
`serviceName` string | Specifies the name of the referenced service.
`servicePort` | Specifies the port of the referenced service.

# IngressBackend v1beta1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1beta1` | `IngressBackend`

Other API versions of this object exist: v1
Appears In:

- HTTPIngressPath [networking/v1beta1]
- IngressSpec [networking/v1beta1]

Field | Description
--- | ---
`resource` TypedLocalObjectReference | Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.
`serviceName` string | Specifies the name of the referenced service.
`servicePort` | Specifies the port of the referenced service.

# IngressClass v1beta1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1beta1` | `IngressClass`

Other API versions of this object exist: v1
Appears In:

- IngressClassList [networking/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` IngressClassSpec | Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

### IngressClassSpec v1beta1 networking

Appears In:

- IngressClass [networking/v1beta1]

Field | Description
--- | ---
`controller` string | Controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable.
`parameters` IngressClassParametersReference | Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.

### IngressClassList v1beta1 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/sig-architecture/api-conventions.md#resources
`items` IngressClass array | Items is the list of IngressClasses.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata.

## Write Operations

## Create

create an IngressClass

### HTTP Request

`POST /apis/networking.k8s.io/v1beta1/ingressclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` IngressClass |

### Response

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

## Patch

partially update the specified IngressClass

### HTTP Request

`PATCH /apis/networking.k8s.io/v1beta1/ingressclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the IngressClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 IngressClass | OK

## Replace

replace the specified IngressClass

### HTTP Request

`PUT /apis/networking.k8s.io/v1beta1/ingressclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the IngressClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` IngressClass |

### Response

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

## Delete

delete an IngressClass

### HTTP Request

`DELETE /apis/networking.k8s.io/v1beta1/ingressclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the IngressClass

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of IngressClass

### HTTP Request

`DELETE /apis/networking.k8s.io/v1beta1/ingressclasses`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified IngressClass

### HTTP Request

`GET /apis/networking.k8s.io/v1beta1/ingressclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the IngressClass

### Query Parameters

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

### Response

Code | Description
--- | ---
200 IngressClass | OK

## List

list or watch objects of kind IngressClass

### HTTP Request

`GET /apis/networking.k8s.io/v1beta1/ingressclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 IngressClassList | OK

## Watch

watch changes to an object of kind IngressClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/networking.k8s.io/v1beta1/watch/ingressclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the IngressClass

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of IngressClass. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/networking.k8s.io/v1beta1/watch/ingressclasses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# IngressClassParametersReference v1beta1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1beta1` | `IngressClassParametersReference`

Other API versions of this object exist: v1
Appears In:

- IngressClassSpec [networking/v1beta1]

Field | Description
--- | ---
`apiGroup` string | APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
`kind` string | Kind is the type of resource being referenced.
`name` string | Name is the name of resource being referenced.
`namespace` string | Namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster".
`scope` string | Scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace". Field can be enabled with IngressClassNamespacedParams feature gate.

# IngressRule v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `IngressRule`

Other API versions of this object exist: v1
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 RFC 3986: 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. Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '\*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.
`http` HTTPIngressRuleValue |

# IngressRule v1beta1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1beta1` | `IngressRule`

Other API versions of this object exist: v1
Appears In:

- IngressSpec [networking/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 RFC 3986: 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. Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '\*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.
`http` HTTPIngressRuleValue |

# IngressTLS v1beta1 extensions

Group | Version | Kind
--- | --- | ---
`extensions` | `v1beta1` | `IngressTLS`

Other API versions of this object exist: v1
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.

# IngressTLS v1beta1 networking.k8s.io

Group | Version | Kind
--- | --- | ---
`networking.k8s.io` | `v1beta1` | `IngressTLS`

Other API versions of this object exist: v1
Appears In:

- IngressSpec [networking/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 TLS traffic on port 443. Field is left optional to allow TLS 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.

# JSON v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `JSON`

Other API versions of this object exist: v1
Appears In:

- JSONSchemaProps [apiextensions/v1beta1]

Field | Description
--- | ---

# JSONSchemaProps v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `JSONSchemaProps`

Other API versions of this object exist: v1
Appears In:

- CustomResourceValidation [apiextensions/v1beta1]
- JSONSchemaProps [apiextensions/v1beta1]

Field | Description
--- | ---
`$ref` string |
`$schema` string |
`additionalItems` JSONSchemaPropsOrBool |
`additionalProperties` JSONSchemaPropsOrBool |
`allOf` JSONSchemaProps array |
`anyOf` JSONSchemaProps array |
`default` JSON | default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. CustomResourceDefinitions with defaults must be created using the v1 (or newer) CustomResourceDefinition API.
`definitions` object |
`dependencies` object |
`description` string |
`enum` JSON array |
`example` JSON |
`exclusiveMaximum` boolean |
`exclusiveMinimum` boolean |
`externalDocs` ExternalDocumentation |
`format` string | format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: - bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
`id` string |
`items` JSONSchemaPropsOrArray |
`maxItems` integer |
`maxLength` integer |
`maxProperties` integer |
`maximum` number |
`minItems` integer |
`minLength` integer |
`minProperties` integer |
`minimum` number |
`multipleOf` number |
`not` JSONSchemaProps |
`nullable` boolean |
`oneOf` JSONSchemaProps array |
`pattern` string |
`patternProperties` object |
`properties` object |
`required` string array |
`title` string |
`type` string |
`uniqueItems` boolean |
`x-kubernetes-embedded-resource` boolean | x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
`x-kubernetes-int-or-string` boolean | x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: 1) anyOf: - type: integer - type: string 2) allOf: - anyOf: - type: integer - type: string - ... zero or more
`x-kubernetes-list-map-keys` string array | x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
`x-kubernetes-list-type` string | x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: 1) `atomic`: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...). 2) `set`: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type `atomic` or an array with x-kubernetes-list-type `atomic`. 3) `map`: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.
`x-kubernetes-map-type` string | x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: 1) `granular`: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2) `atomic`: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.
`x-kubernetes-preserve-unknown-fields` boolean | x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.

# JSONSchemaPropsOrArray v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `JSONSchemaPropsOrArray`

Other API versions of this object exist: v1
Appears In:

- JSONSchemaProps [apiextensions/v1beta1]

Field | Description
--- | ---

# JSONSchemaPropsOrBool v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `JSONSchemaPropsOrBool`

Other API versions of this object exist: v1
Appears In:

- JSONSchemaProps [apiextensions/v1beta1]

Field | Description
--- | ---

# JobTemplateSpec v1beta1 batch

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

Other API versions of this object exist: v1
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/sig-architecture/api-conventions.md#metadata
`spec` JobSpec | Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

# Lease v1beta1 coordination.k8s.io

Group | Version | Kind
--- | --- | ---
`coordination.k8s.io` | `v1beta1` | `Lease`

Other API versions of this object exist: v1
Appears In:

- LeaseList [coordination/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` LeaseSpec | Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

### LeaseSpec v1beta1 coordination

Appears In:

- Lease [coordination/v1beta1]

Field | Description
--- | ---
`acquireTime` MicroTime | acquireTime is a time when the current lease was acquired.
`holderIdentity` string | holderIdentity contains the identity of the holder of a current lease.
`leaseDurationSeconds` integer | leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.
`leaseTransitions` integer | leaseTransitions is the number of transitions of a lease between holders.
`renewTime` MicroTime | renewTime is a time when the current holder of a lease has last updated the lease.

### LeaseList v1beta1 coordination

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/sig-architecture/api-conventions.md#resources
`items` Lease 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a Lease

### HTTP Request

`POST /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases`

### 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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Lease |

### Response

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

## Patch

partially update the specified Lease

### HTTP Request

`PATCH /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Lease | OK

## Replace

replace the specified Lease

### HTTP Request

`PUT /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Lease |

### Response

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

## Delete

delete a Lease

### HTTP Request

`DELETE /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name}`

### Path Parameters

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

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of Lease

### HTTP Request

`DELETE /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified Lease

### HTTP Request

`GET /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the Lease
`namespace` | 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 Lease | OK

## List

list or watch objects of kind Lease

### HTTP Request

`GET /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases`

### 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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 LeaseList | OK

## List All Namespaces

list or watch objects of kind Lease

### HTTP Request

`GET /apis/coordination.k8s.io/v1beta1/leases`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 LeaseList | OK

## Watch

watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/coordination.k8s.io/v1beta1/watch/namespaces/{namespace}/leases/{name}`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/coordination.k8s.io/v1beta1/watch/namespaces/{namespace}/leases`

### Path Parameters

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

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/coordination.k8s.io/v1beta1/watch/leases`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# LocalSubjectAccessReview v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `LocalSubjectAccessReview`

Other API versions of this object exist: 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/sig-architecture/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/sig-architecture/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

## Create

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
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`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

# MetricSpec v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `MetricSpec`

Other API versions of this object exist: v2beta2
Appears In:

- HorizontalPodAutoscalerSpec [autoscaling/v2beta1]

Field | Description
--- | ---
`containerResource` ContainerResourceMetricSource | container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of 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. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
`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 "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled

# MetricStatus v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `MetricStatus`

Other API versions of this object exist: v2beta2
Appears In:

- HorizontalPodAutoscalerStatus [autoscaling/v2beta1]

Field | Description
--- | ---
`containerResource` ContainerResourceMetricStatus | container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in 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.
`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 "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled

# MutatingWebhook v1beta1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `MutatingWebhook`

Other API versions of this object exist: v1
Appears In:

- MutatingWebhookConfiguration [admissionregistration/v1beta1]

Field | Description
--- | ---
`admissionReviewVersions` string array | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`.
`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.
`matchPolicy` string | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Exact"
`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.
`objectSelector` LabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
`reinvocationPolicy` string | reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". Never: the webhook will not be called more than once in a single admission evaluation. IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. Defaults to "Never".
`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.
`sideEffects` string | SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown.
`timeoutSeconds` integer | TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds.

# MutatingWebhookConfiguration v1beta1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `MutatingWebhookConfiguration`

Other API versions of this object exist: v1
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
`webhooks` MutatingWebhook array patch strategy: 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` MutatingWebhookConfiguration |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 MutatingWebhookConfiguration | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` MutatingWebhookConfiguration |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 MutatingWebhookConfiguration | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the MutatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# NonResourceAttributes v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `NonResourceAttributes`

Other API versions of this object exist: v1
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
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.

# ObjectMetricSource v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `ObjectMetricSource`

Other API versions of this object exist: v2beta2
Appears In:

- MetricSpec [autoscaling/v2beta1]

Field | Description
--- | ---
`averageValue` Quantity | averageValue is the target 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.
`selector` LabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics.
`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`

Other API versions of this object exist: v2beta2
Appears In:

- MetricStatus [autoscaling/v2beta1]

Field | Description
--- | ---
`averageValue` Quantity | averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
`currentValue` Quantity | currentValue is the current value of the metric (as a quantity).
`metricName` string | metricName is the name of the metric in question.
`selector` LabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the ObjectMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
`target` CrossVersionObjectReference | target is the described Kubernetes object.

# Overhead v1beta1 node.k8s.io

Group | Version | Kind
--- | --- | ---
`node.k8s.io` | `v1beta1` | `Overhead`

Other API versions of this object exist: v1 v1alpha1
Appears In:

- RuntimeClass [node/v1beta1]

Field | Description
--- | ---
`podFixed` object | PodFixed represents the fixed resource overhead associated with running a pod.

# Overhead v1alpha1 node.k8s.io

Group | Version | Kind
--- | --- | ---
`node.k8s.io` | `v1alpha1` | `Overhead`

Other API versions of this object exist: v1 v1beta1
Appears In:

- RuntimeClassSpec [node/v1alpha1]

Field | Description
--- | ---
`podFixed` object | PodFixed represents the fixed resource overhead associated with running a pod.

# PodDisruptionBudget v1beta1 policy

Group | Version | Kind
--- | --- | ---
`policy` | `v1beta1` | `PodDisruptionBudget`

Other API versions of this object exist: v1
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/sig-architecture/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/sig-architecture/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 patch strategy: replace | Label query over pods whose evictions are managed by the disruption budget. A null selector selects no pods. An empty selector ({}) also selects no pods, which differs from standard behavior of selecting all pods. In policy/v1, an empty selector will select all pods in the namespace.

### PodDisruptionBudgetStatus v1beta1 policy

Appears In:

- PodDisruptionBudget [policy/v1beta1]

Field | Description
--- | ---
`conditions` Condition array patch strategy: merge patch merge key: type | Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the future): - SyncFailed: The controller encountered an error and wasn't able to compute the number of allowed disruptions. Therefore no disruptions are allowed and the status of the condition will be False. - InsufficientPods: The number of pods are either at or below the number required by the PodDisruptionBudget. No disruptions are allowed and the status of the condition will be False. - SufficientPods: There are more pods than required by the PodDisruptionBudget. The condition will be True, and the number of allowed disruptions are provided by the disruptionsAllowed property.
`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. DisruptionsAllowed and other status information 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta |

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PodDisruptionBudget |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PodDisruptionBudget |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind PodDisruptionBudget

### HTTP Request

`GET /apis/policy/v1beta1/poddisruptionbudgets`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/policy/v1beta1/watch/poddisruptionbudgets`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

## Patch Status

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PodDisruptionBudget | OK

## Read Status

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

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PodDisruptionBudget |

### Response

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

# PodsMetricSource v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `PodsMetricSource`

Other API versions of this object exist: v2beta2
Appears In:

- MetricSpec [autoscaling/v2beta1]

Field | Description
--- | ---
`metricName` string | metricName is the name of the metric in question
`selector` LabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics.
`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`

Other API versions of this object exist: v2beta2
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
`selector` LabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the PodsMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.

# PolicyRule v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `PolicyRule`

Other API versions of this object exist: v1 v1alpha1
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
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 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.

# PriorityClass v1beta1 scheduling.k8s.io

Group | Version | Kind
--- | --- | ---
`scheduling.k8s.io` | `v1beta1` | `PriorityClass`

Other API versions of this object exist: v1 v1alpha1
Appears In:

- PriorityClassList [scheduling/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`preemptionPolicy` string | PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
`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 v1beta1 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a PriorityClass

### HTTP Request

`POST /apis/scheduling.k8s.io/v1beta1/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityClass |

### Response

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

## Patch

partially update the specified PriorityClass

### HTTP Request

`PATCH /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PriorityClass | OK

## Replace

replace the specified PriorityClass

### HTTP Request

`PUT /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityClass |

### Response

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

## Delete

delete a PriorityClass

### HTTP Request

`DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of PriorityClass

### HTTP Request

`DELETE /apis/scheduling.k8s.io/v1beta1/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified PriorityClass

### HTTP Request

`GET /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

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

### Response

Code | Description
--- | ---
200 PriorityClass | OK

## List

list or watch objects of kind PriorityClass

### HTTP Request

`GET /apis/scheduling.k8s.io/v1beta1/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# PriorityClass v1alpha1 scheduling.k8s.io

Group | Version | Kind
--- | --- | ---
`scheduling.k8s.io` | `v1alpha1` | `PriorityClass`

Other API versions of this object exist: v1 v1beta1
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`preemptionPolicy` string | PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityClass |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 PriorityClass | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` PriorityClass |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 PriorityClass | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the PriorityClass

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# ResourceAttributes v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `ResourceAttributes`

Other API versions of this object exist: v1
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.

# ResourceMetricSource v2beta1 autoscaling

Group | Version | Kind
--- | --- | ---
`autoscaling` | `v2beta1` | `ResourceMetricSource`

Other API versions of this object exist: v2beta2
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`

Other API versions of this object exist: v2beta2
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.

# ResourceRule v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `ResourceRule`

Other API versions of this object exist: v1
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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Role | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/roles`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Role | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` Role |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind Role

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/roles`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 RoleBinding | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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
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/sig-architecture/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/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard object's metadata.

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 RoleBinding | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RoleBinding |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

list or watch objects of kind RoleBinding

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

### 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
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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
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
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

# RuleWithOperations v1beta1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `RuleWithOperations`

Other API versions of this object exist: v1
Appears In:

- MutatingWebhook [admissionregistration/v1beta1]
- ValidatingWebhook [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, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. 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.
`scope` string | scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".

# RuntimeClass v1beta1 node.k8s.io

Group | Version | Kind
--- | --- | ---
`node.k8s.io` | `v1beta1` | `RuntimeClass`

Other API versions of this object exist: v1 v1alpha1
Appears In:

- RuntimeClassList [node/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/sig-architecture/api-conventions.md#resources
`handler` string | Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable.
`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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`overhead` Overhead | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.
`scheduling` Scheduling | Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes.

### RuntimeClassList v1beta1 node

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/sig-architecture/api-conventions.md#resources
`items` RuntimeClass 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a RuntimeClass

### HTTP Request

`POST /apis/node.k8s.io/v1beta1/runtimeclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RuntimeClass |

### Response

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

## Patch

partially update the specified RuntimeClass

### HTTP Request

`PATCH /apis/node.k8s.io/v1beta1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 RuntimeClass | OK

## Replace

replace the specified RuntimeClass

### HTTP Request

`PUT /apis/node.k8s.io/v1beta1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RuntimeClass |

### Response

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

## Delete

delete a RuntimeClass

### HTTP Request

`DELETE /apis/node.k8s.io/v1beta1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of RuntimeClass

### HTTP Request

`DELETE /apis/node.k8s.io/v1beta1/runtimeclasses`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified RuntimeClass

### HTTP Request

`GET /apis/node.k8s.io/v1beta1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

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

### Response

Code | Description
--- | ---
200 RuntimeClass | OK

## List

list or watch objects of kind RuntimeClass

### HTTP Request

`GET /apis/node.k8s.io/v1beta1/runtimeclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RuntimeClassList | OK

## Watch

watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/node.k8s.io/v1beta1/watch/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/node.k8s.io/v1beta1/watch/runtimeclasses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# RuntimeClass v1alpha1 node.k8s.io

Group | Version | Kind
--- | --- | ---
`node.k8s.io` | `v1alpha1` | `RuntimeClass`

Other API versions of this object exist: v1 v1beta1
Appears In:

- RuntimeClassList [node/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec` RuntimeClassSpec | Specification of the RuntimeClass More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

### RuntimeClassSpec v1alpha1 node

Appears In:

- RuntimeClass [node/v1alpha1]

Field | Description
--- | ---
`overhead` Overhead | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.
`runtimeHandler` string | RuntimeHandler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The RuntimeHandler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable.
`scheduling` Scheduling | Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes.

### RuntimeClassList v1alpha1 node

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/sig-architecture/api-conventions.md#resources
`items` RuntimeClass 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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

create a RuntimeClass

### HTTP Request

`POST /apis/node.k8s.io/v1alpha1/runtimeclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RuntimeClass |

### Response

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

## Patch

partially update the specified RuntimeClass

### HTTP Request

`PATCH /apis/node.k8s.io/v1alpha1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 RuntimeClass | OK

## Replace

replace the specified RuntimeClass

### HTTP Request

`PUT /apis/node.k8s.io/v1alpha1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` RuntimeClass |

### Response

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

## Delete

delete a RuntimeClass

### HTTP Request

`DELETE /apis/node.k8s.io/v1alpha1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

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

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

delete collection of RuntimeClass

### HTTP Request

`DELETE /apis/node.k8s.io/v1alpha1/runtimeclasses`

### 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

read the specified RuntimeClass

### HTTP Request

`GET /apis/node.k8s.io/v1alpha1/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

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

### Response

Code | Description
--- | ---
200 RuntimeClass | OK

## List

list or watch objects of kind RuntimeClass

### HTTP Request

`GET /apis/node.k8s.io/v1alpha1/runtimeclasses`

### Query Parameters

Parameter | Description
--- | ---
`pretty` | If 'true', then the output is pretty printed.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

### Response

Code | Description
--- | ---
200 RuntimeClassList | OK

## Watch

watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/node.k8s.io/v1alpha1/watch/runtimeclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the RuntimeClass

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/node.k8s.io/v1alpha1/watch/runtimeclasses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# Scheduling v1beta1 node.k8s.io

Group | Version | Kind
--- | --- | ---
`node.k8s.io` | `v1beta1` | `Scheduling`

Other API versions of this object exist: v1 v1alpha1
Appears In:

- RuntimeClass [node/v1beta1]

Field | Description
--- | ---
`nodeSelector` object | nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission.
`tolerations` Toleration array | tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass.

# Scheduling v1alpha1 node.k8s.io

Group | Version | Kind
--- | --- | ---
`node.k8s.io` | `v1alpha1` | `Scheduling`

Other API versions of this object exist: v1 v1beta1
Appears In:

- RuntimeClassSpec [node/v1alpha1]

Field | Description
--- | ---
`nodeSelector` object | nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission.
`tolerations` Toleration array | tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass.

# SelfSubjectAccessReview v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `SelfSubjectAccessReview`

Other API versions of this object exist: 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/sig-architecture/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/sig-architecture/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

## Create

create a SelfSubjectAccessReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1beta1/selfsubjectaccessreviews`

### Query Parameters

Parameter | Description
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`pretty` | If 'true', then the output is pretty printed.

### Body Parameters

Parameter | Description
--- | ---
`body` SelfSubjectAccessReview |

### Response

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

# SelfSubjectRulesReview v1beta1 authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`authorization.k8s.io` | `v1beta1` | `SelfSubjectRulesReview`

Other API versions of this object exist: 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/sig-architecture/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/sig-architecture/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

## Create

create a SelfSubjectRulesReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1beta1/selfsubjectrulesreviews`

### Query Parameters

Parameter | Description
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`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

# ServiceReference v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `ServiceReference`

Other API versions of this object exist: v1beta1 v1beta1 v1beta1
Appears In:

- WebhookClientConfig [apiextensions/v1]

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 at which the webhook will be contacted.
`port` integer | port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.

# ServiceReference v1 apiregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`apiregistration.k8s.io` | `v1` | `ServiceReference`

Other API versions of this object exist: v1beta1 v1beta1 v1beta1
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
`port` integer | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).

# ServiceReference v1beta1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `ServiceReference`

Other API versions of this object exist: v1 v1 v1
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.
`port` integer | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).

# ServiceReference v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `ServiceReference`

Other API versions of this object exist: v1 v1 v1
Appears In:

- WebhookClientConfig [apiextensions/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 at which the webhook will be contacted.
`port` integer | port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.

# ServiceReference v1beta1 apiregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`apiregistration.k8s.io` | `v1beta1` | `ServiceReference`

Other API versions of this object exist: v1 v1 v1
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
`port` integer | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).

# StorageClass v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `StorageClass`

Other API versions of this object exist: v1
Appears In:

- StorageClassList [storage/v1beta1]

Field | Description
--- | ---
`allowVolumeExpansion` boolean | AllowVolumeExpansion shows whether the storage class allow volume expand
`allowedTopologies` TopologySelectorTerm array | Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
`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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageClass |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 StorageClass | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` StorageClass |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 StorageClass | OK
202 StorageClass | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 StorageClass | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the StorageClass

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/storageclasses`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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 v1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1` | `Subject`

Other API versions of this object exist: v1beta1 v1beta1 v1alpha1
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.

# Subject v1beta1 rbac.authorization.k8s.io

Group | Version | Kind
--- | --- | ---
`rbac.authorization.k8s.io` | `v1beta1` | `Subject`

Other API versions of this object exist: v1 v1alpha1
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: v1beta1 v1 v1beta1
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

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/sig-architecture/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/sig-architecture/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

## Create

create a SubjectAccessReview

### HTTP Request

`POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews`

### Query Parameters

Parameter | Description
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`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
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.

# TokenRequest v1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1` | `TokenRequest`

Other API versions of this object exist: v1beta1
Appears In:

- CSIDriverSpec [storage/v1]

Field | Description
--- | ---
`audience` string | Audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver.
`expirationSeconds` integer | ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec".

# TokenRequest v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `TokenRequest`

Other API versions of this object exist: v1 v1
Appears In:

- CSIDriverSpec [storage/v1beta1]

Field | Description
--- | ---
`audience` string | Audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver.
`expirationSeconds` integer | ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec"

# TokenReview v1beta1 authentication.k8s.io

Group | Version | Kind
--- | --- | ---
`authentication.k8s.io` | `v1beta1` | `TokenReview`

Other API versions of this object exist: 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/sig-architecture/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/sig-architecture/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
--- | ---
`audiences` string array | Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver.
`token` string | Token is the opaque bearer token.

### TokenReviewStatus v1beta1 authentication

Appears In:

- TokenReview [authentication/v1beta1]

Field | Description
--- | ---
`audiences` string array | Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server.
`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

## Create

create a TokenReview

### HTTP Request

`POST /apis/authentication.k8s.io/v1beta1/tokenreviews`

### Query Parameters

Parameter | Description
--- | ---
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`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
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.

# ValidatingWebhook v1beta1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `ValidatingWebhook`

Other API versions of this object exist: v1
Appears In:

- ValidatingWebhookConfiguration [admissionregistration/v1beta1]

Field | Description
--- | ---
`admissionReviewVersions` string array | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`.
`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.
`matchPolicy` string | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Exact"
`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.
`objectSelector` LabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. 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.
`sideEffects` string | SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown.
`timeoutSeconds` integer | TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds.

# ValidatingWebhookConfiguration v1beta1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `ValidatingWebhookConfiguration`

Other API versions of this object exist: v1
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
`webhooks` ValidatingWebhook array patch strategy: 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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ValidatingWebhookConfiguration |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 ValidatingWebhookConfiguration | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` ValidatingWebhookConfiguration |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK
202 Status | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 ValidatingWebhookConfiguration | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the ValidatingWebhookConfiguration

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# VolumeAttachment v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `VolumeAttachment`

Other API versions of this object exist: v1 v1alpha1
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK
202 VolumeAttachment | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

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

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

# VolumeAttachment v1alpha1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1alpha1` | `VolumeAttachment`

Other API versions of this object exist: v1 v1beta1
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
`metadata` ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

## Write Operations

## Create

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

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

## Patch

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## Replace

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

### Body Parameters

Parameter | Description
--- | ---
`body` VolumeAttachment |

### Response

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

## Delete

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.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK
202 VolumeAttachment | Accepted

## Delete Collection

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`dryRun` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`gracePeriodSeconds` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`orphanDependents` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`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.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

### Body Parameters

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

### Response

Code | Description
--- | ---
200 Status | OK

## Read Operations

## Read

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.

### Response

Code | Description
--- | ---
200 VolumeAttachment | OK

## List

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.
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments/{name}`

### Path Parameters

Parameter | Description
--- | ---
`name` | name of the VolumeAttachment

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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

watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.

### HTTP Request

`GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments`

### Query Parameters

Parameter | Description
--- | ---
`allowWatchBookmarks` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector` | A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector` | A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty` | If 'true', then the output is pretty printed.
`resourceVersion` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch` | Watch 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 v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `VolumeAttachmentSource`

Other API versions of this object exist: v1 v1alpha1
Appears In:

- VolumeAttachmentSpec [storage/v1beta1]

Field | Description
--- | ---
`inlineVolumeSpec` PersistentVolumeSpec | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature.
`persistentVolumeName` string | Name of the persistent volume to attach.

# VolumeAttachmentSource v1alpha1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1alpha1` | `VolumeAttachmentSource`

Other API versions of this object exist: v1 v1beta1
Appears In:

- VolumeAttachmentSpec [storage/v1alpha1]

Field | Description
--- | ---
`inlineVolumeSpec` PersistentVolumeSpec | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature.
`persistentVolumeName` string | Name of the persistent volume to attach.

# VolumeError v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `VolumeError`

Other API versions of this object exist: v1 v1alpha1
Appears In:

- VolumeAttachmentStatus [storage/v1beta1]

Field | Description
--- | ---
`message` string | String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
`time` Time | Time the error was encountered.

# VolumeError v1alpha1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1alpha1` | `VolumeError`

Other API versions of this object exist: v1 v1beta1
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.

# VolumeNodeResources v1beta1 storage.k8s.io

Group | Version | Kind
--- | --- | ---
`storage.k8s.io` | `v1beta1` | `VolumeNodeResources`

Other API versions of this object exist: v1
Appears In:

- CSINodeDriver [storage/v1beta1]

Field | Description
--- | ---
`count` integer | Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is nil, then the supported number of volumes on this node is unbounded.

# WebhookClientConfig v1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1` | `WebhookClientConfig`

Other API versions of this object exist: v1beta1 v1beta1
Appears In:

- WebhookConversion [apiextensions/v1]

Field | Description
--- | ---
`caBundle` string | caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
`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`.
`url` string | url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.

# WebhookClientConfig v1beta1 admissionregistration.k8s.io

Group | Version | Kind
--- | --- | ---
`admissionregistration.k8s.io` | `v1beta1` | `WebhookClientConfig`

Other API versions of this object exist: v1 v1
Appears In:

- MutatingWebhook [admissionregistration/v1beta1]
- ValidatingWebhook [admissionregistration/v1beta1]

Field | Description
--- | ---
`caBundle` string | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
`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`.
`url` string | `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.

# WebhookClientConfig v1beta1 apiextensions.k8s.io

Group | Version | Kind
--- | --- | ---
`apiextensions.k8s.io` | `v1beta1` | `WebhookClientConfig`

Other API versions of this object exist: v1 v1
Appears In:

- CustomResourceConversion [apiextensions/v1beta1]

Field | Description
--- | ---
`caBundle` string | caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
`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`.
`url` string | url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.