website/docs/api-reference/v1.5/documents/_generated_persistentvolumeclaim_v1_concept.md

---

PersistentVolumeClaim v1

Group	Version	Kind
Core	v1	PersistentVolumeClaim

A PersistentVolume must be allocated in the cluster to use this.

PersistentVolumeClaim is a user's request for and claim to a persistent volume

Appears In PersistentVolumeClaimList StatefulSetSpec

Field	Description
metadata ObjectMeta	Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec PersistentVolumeClaimSpec	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	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

Appears In PersistentVolumeClaim

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	Resources represents the minimum resources the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
selector LabelSelector	A label query over volumes to consider for binding.
volumeName string	VolumeName is the binding reference to the PersistentVolume backing this claim.

PersistentVolumeClaimStatus v1

Appears In PersistentVolumeClaim

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
items PersistentVolumeClaim array	A list of persistent volume claims. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims
metadata ListMeta	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

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

create a PersistentVolumeClaim

HTTP Request

POST /api/v1/namespaces/{namespace}/persistentvolumeclaims

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.

Query Parameters

Parameter	Description
body PersistentVolumeClaim

Response

Code	Description
200 PersistentVolumeClaim	OK

Replace

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

replace the specified PersistentVolumeClaim

HTTP Request

PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

Path Parameters

Parameter	Description
name	name of the PersistentVolumeClaim
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.

Query Parameters

Parameter	Description
body PersistentVolumeClaim

Response

Code	Description
200 PersistentVolumeClaim	OK

Patch

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

partially update the specified PersistentVolumeClaim

HTTP Request

PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

Path Parameters

Parameter	Description
name	name of the PersistentVolumeClaim
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.

Query Parameters

Parameter	Description
body Patch

Response

Code	Description
200 PersistentVolumeClaim	OK

Delete

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

delete a PersistentVolumeClaim

HTTP Request

DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

Path Parameters

Parameter	Description
name	name of the PersistentVolumeClaim
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.

Query Parameters

Parameter	Description
body DeleteOptions
gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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.

Response

Code	Description
200 Status	OK

Delete Collection

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

delete collection of PersistentVolumeClaim

HTTP Request

DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.

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.
resourceVersion	When 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	OK

Read Operations

See supported operations below...

Read

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

read the specified PersistentVolumeClaim

HTTP Request

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

Path Parameters

Parameter	Description
name	name of the PersistentVolumeClaim
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.

Query Parameters

Parameter	Description
exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
export	Should this value be exported. Export strips fields that a user can not specify.

Response

Code	Description
200 PersistentVolumeClaim	OK

List

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

list or watch objects of kind PersistentVolumeClaim

HTTP Request

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.

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.
resourceVersion	When 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	OK

List All Namespaces

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

list or watch objects of kind PersistentVolumeClaim

HTTP Request

GET /api/v1/persistentvolumeclaims

Path 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	OK

Watch

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

watch changes to an object of kind PersistentVolumeClaim

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}

Path Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
name	name of the PersistentVolumeClaim
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.
resourceVersion	When 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	OK

Watch List All Namespaces

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

watch individual changes to a list of PersistentVolumeClaim

HTTP Request

GET /api/v1/watch/persistentvolumeclaims

Path 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	OK

Status Operations

See supported operations below...

Patch Status

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

partially update status of the specified PersistentVolumeClaim

HTTP Request

PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

Path Parameters

Parameter	Description
name	name of the PersistentVolumeClaim
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.

Query Parameters

Parameter	Description
body Patch

Response

Code	Description
200 PersistentVolumeClaim	OK

Read Status

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

read status of the specified PersistentVolumeClaim

HTTP Request

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

Path Parameters

Parameter	Description
name	name of the PersistentVolumeClaim
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.

Response

Code	Description
200 PersistentVolumeClaim	OK

Replace Status

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

replace status of the specified PersistentVolumeClaim

HTTP Request

PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

Path Parameters

Parameter	Description
name	name of the PersistentVolumeClaim
namespace	object name and auth scope, such as for teams and projects
pretty	If 'true', then the output is pretty printed.

Query Parameters

Parameter	Description
body PersistentVolumeClaim

Response

Code	Description
200 PersistentVolumeClaim	OK