Skip to main content
Version: v1.4 (latest)

Delete a Namespaced Persistent Volume Claim

DELETE 
/api/v1/namespaces/:namespace/persistentvolumeclaims/:name

Delete a PersistentVolumeClaim object.

Request​

Path Parameters

    name stringrequired

    Possible values: Value must match regular expression [a-z0-9][a-z0-9\-]*

    Name of the resource

    namespace stringrequired

    Possible values: Value must match regular expression [a-z0-9][a-z0-9\-]*

    Object name and auth scope, such as for teams and projects

Query Parameters

    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.

    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.

    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.

Body

required
    apiVersion stringrequired
    dryRun string[]
    gracePeriodSeconds int64
    kind stringrequired
    orphanDependents boolean
    preconditions object
    resourceVersion string
    uid string
    propagationPolicy string

Responses​

OK

Schema
    apiVersion stringrequired
    code int32
    details object
    causes object[]
    group string
    kind string
    name string
    retryAfterSeconds int32
    uid string
    kind stringrequired
    message string
    metadata object
    continue string
    remainingItemCount int64
    resourceVersion string
    selfLink string
    reason string
    status string
Loading...