List Persistent Volume Claims
Retrieve a list of all Persistent Volume Claims in the cluster.
GET /api/v1/persistentvolumeclaims
Query Parameters
The kubeconfig identifier to use for the request
The cluster context to use for the request
Filter results by namespace (optional)
Response
Returns an array of Persistent Volume Claim objects.
Unique identifier for the Persistent Volume Claim
Namespace where the PVC is located
Name of the Persistent Volume Claim
Creation timestamp of the Persistent Volume Claim
Specification of the Persistent Volume Claim
Name of the Persistent Volume bound to this claim
The storage class name for dynamic provisioning
Volume mode (e.g., Filesystem, Block)
Requested storage capacity (e.g., “10Gi”)
Current status of the Persistent Volume Claim
Current phase of the claim (Pending, Bound, Lost)
Example Request
curl -X GET "https://your-kubewall-instance/api/v1/persistentvolumeclaims?config=default&cluster=production&namespace=default" \
-H "Content-Type: application/json"
Example Response
[
{
"uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"namespace": "default",
"name": "data-claim",
"age": "2024-03-01T11:00:00Z",
"spec": {
"volumeName": "pv-nfs-data",
"storageClassName": "nfs-storage",
"volumeMode": "Filesystem",
"storage": "10Gi"
},
"status": {
"phase": "Bound"
}
}
]
Get Persistent Volume Claim Details
Retrieve detailed information about a specific Persistent Volume Claim.
GET /api/v1/persistentvolumeclaims/:name
Path Parameters
Name of the Persistent Volume Claim to retrieve
Query Parameters
The kubeconfig identifier to use for the request
The cluster context to use for the request
Namespace of the Persistent Volume Claim
Example Request
curl -X GET "https://your-kubewall-instance/api/v1/persistentvolumeclaims/data-claim?config=default&cluster=production&namespace=default" \
-H "Content-Type: application/json"
Get Persistent Volume Claim YAML
Retrieve the YAML manifest of a Persistent Volume Claim.
GET /api/v1/persistentvolumeclaims/:name/yaml
Path Parameters
Name of the Persistent Volume Claim
Query Parameters
The kubeconfig identifier to use for the request
The cluster context to use for the request
Namespace of the Persistent Volume Claim
Example Request
curl -X GET "https://your-kubewall-instance/api/v1/persistentvolumeclaims/data-claim/yaml?config=default&cluster=production&namespace=default" \
-H "Content-Type: application/json"
Example Response
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: data-claim
namespace: default
spec:
accessModes:
- ReadWriteMany
storageClassName: nfs-storage
resources:
requests:
storage: 10Gi
status:
phase: Bound
accessModes:
- ReadWriteMany
capacity:
storage: 10Gi
Get Persistent Volume Claim Events
Retrieve events related to a specific Persistent Volume Claim.
GET /api/v1/persistentvolumeclaims/:name/events
Path Parameters
Name of the Persistent Volume Claim
Query Parameters
The kubeconfig identifier to use for the request
The cluster context to use for the request
Namespace of the Persistent Volume Claim
Example Request
curl -X GET "https://your-kubewall-instance/api/v1/persistentvolumeclaims/data-claim/events?config=default&cluster=production&namespace=default" \
-H "Content-Type: application/json"
Delete Persistent Volume Claim
Delete a Persistent Volume Claim from the cluster.
DELETE /api/v1/persistentvolumeclaims
Query Parameters
The kubeconfig identifier to use for the request
The cluster context to use for the request
Namespace of the Persistent Volume Claim
Name of the Persistent Volume Claim to delete
Example Request
curl -X DELETE "https://your-kubewall-instance/api/v1/persistentvolumeclaims?config=default&cluster=production&namespace=default&name=data-claim" \
-H "Content-Type: application/json"
Response
Returns a success status code (204) if the deletion was successful.