Skip to main content

List Persistent Volumes

Returns the persistent volumes on the cluster - each PV's pv_id, pv_name, pv_size (in MB), status (e.g. BOUND), and creation time. The path takes the cluster_id (from List / Detail).

GET/api/v1/persistent_volume/{cluster_id}/

Path parameters

  • cluster_idPathintegerrequired

    The cluster_id of the cluster (from List / Detail).

    • required
    • must be a valid cluster_id
    example10001

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the cluster.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Responses

200Successful response
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess