----------- # PersistentVolumeClaim v1 Group | Version | Kind ------------ | ---------- | ----------- Core | v1 | PersistentVolumeClaim PersistentVolumeClaim is a user's request for and claim to a persistent volume Field | Description ------------ | ----------- apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata spec
*[PersistentVolumeClaimSpec](#persistentvolumeclaimspec-v1)* | Spec defines the desired characteristics of a volume requested by a pod author. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims status
*[PersistentVolumeClaimStatus](#persistentvolumeclaimstatus-v1)* | Status represents the current information/status of a persistent volume claim. Read-only. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims ### PersistentVolumeClaimSpec v1 Field | Description ------------ | ----------- accessModes
*string array* | AccessModes contains the desired access modes the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1 resources
*[ResourceRequirements](#resourcerequirements-v1)* | Resources represents the minimum resources the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources selector
*[LabelSelector](#labelselector-unversioned)* | A label query over volumes to consider for binding. volumeName
*string* | VolumeName is the binding reference to the PersistentVolume backing this claim. ### PersistentVolumeClaimStatus v1 Field | Description ------------ | ----------- accessModes
*string array* | AccessModes contains the actual access modes the volume backing the PVC has. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1 capacity
*object* | Represents the actual resources of the underlying volume. phase
*string* | Phase represents the current phase of PersistentVolumeClaim. ### PersistentVolumeClaimList 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources items
*[PersistentVolumeClaim](#persistentvolumeclaim-v1) array* | A list of persistent volume claims. More info: http://kubernetes.io/docs/user-guide/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds ## Write Operations See supported operations below... ## Create >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` create a PersistentVolumeClaim ### HTTP Request `POST /api/v1/namespaces/{namespace}/persistentvolumeclaims` ### Path Parameters Parameter | Description ------------ | ----------- namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. ### Body Parameters Parameter | Description ------------ | ----------- body
*[PersistentVolumeClaim](#persistentvolumeclaim-v1)* | ### Response Code | Description ------------ | ----------- 200
*[PersistentVolumeClaim](#persistentvolumeclaim-v1)* | OK ## Replace >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` replace the specified PersistentVolumeClaim ### HTTP Request `PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the PersistentVolumeClaim namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. ### Body Parameters Parameter | Description ------------ | ----------- body
*[PersistentVolumeClaim](#persistentvolumeclaim-v1)* | ### Response Code | Description ------------ | ----------- 200
*[PersistentVolumeClaim](#persistentvolumeclaim-v1)* | OK ## Patch >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` partially update the specified PersistentVolumeClaim ### HTTP Request `PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the PersistentVolumeClaim namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. ### Body Parameters Parameter | Description ------------ | ----------- body
*[Patch](#patch-unversioned)* | ### Response Code | Description ------------ | ----------- 200
*[PersistentVolumeClaim](#persistentvolumeclaim-v1)* | OK ## Delete >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` delete a PersistentVolumeClaim ### HTTP Request `DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the PersistentVolumeClaim namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. ### Body Parameters Parameter | Description ------------ | ----------- body
*[DeleteOptions](#deleteoptions-v1)* | ### Response Code | Description ------------ | ----------- 200
*[Status](#status-unversioned)* | OK ## Delete Collection >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` delete collection of PersistentVolumeClaim ### HTTP Request `DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims` ### Path Parameters Parameter | Description ------------ | ----------- namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[Status](#status-unversioned)* | OK ## Read Operations See supported operations below... ## Read >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` read the specified PersistentVolumeClaim ### HTTP Request `GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the PersistentVolumeClaim namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' export | Should this value be exported. Export strips fields that a user can not specify. ### Response Code | Description ------------ | ----------- 200
*[PersistentVolumeClaim](#persistentvolumeclaim-v1)* | OK ## List >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` list or watch objects of kind PersistentVolumeClaim ### HTTP Request `GET /api/v1/namespaces/{namespace}/persistentvolumeclaims` ### Path Parameters Parameter | Description ------------ | ----------- namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[PersistentVolumeClaimList](#persistentvolumeclaimlist-v1)* | OK ## List All Namespaces >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` list or watch objects of kind PersistentVolumeClaim ### HTTP Request `GET /api/v1/persistentvolumeclaims` ### Query Parameters Parameter | Description ------------ | ----------- fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. pretty | If 'true', then the output is pretty printed. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[PersistentVolumeClaimList](#persistentvolumeclaimlist-v1)* | OK ## Watch >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` watch changes to an object of kind PersistentVolumeClaim ### HTTP Request `GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the PersistentVolumeClaim namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. pretty | If 'true', then the output is pretty printed. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[Event](#event-versioned)* | OK ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` watch individual changes to a list of PersistentVolumeClaim ### HTTP Request `GET /api/v1/watch/persistentvolumeclaims` ### Query Parameters Parameter | Description ------------ | ----------- fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. pretty | If 'true', then the output is pretty printed. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[Event](#event-versioned)* | OK ## Status Operations See supported operations below... ## Patch Status >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` partially update status of the specified PersistentVolumeClaim ### HTTP Request `PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the PersistentVolumeClaim namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. ### Body Parameters Parameter | Description ------------ | ----------- body
*[Patch](#patch-unversioned)* | ### Response Code | Description ------------ | ----------- 200
*[PersistentVolumeClaim](#persistentvolumeclaim-v1)* | OK ## Read Status >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` read status of the specified PersistentVolumeClaim ### HTTP Request `GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the PersistentVolumeClaim namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. ### Response Code | Description ------------ | ----------- 200
*[PersistentVolumeClaim](#persistentvolumeclaim-v1)* | OK ## Replace Status >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` replace status of the specified PersistentVolumeClaim ### HTTP Request `PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the PersistentVolumeClaim namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. ### Body Parameters Parameter | Description ------------ | ----------- body
*[PersistentVolumeClaim](#persistentvolumeclaim-v1)* | ### Response Code | Description ------------ | ----------- 200
*[PersistentVolumeClaim](#persistentvolumeclaim-v1)* | OK