kubernetes

Get Kubernetes volumes within a namespace in the given Portainer environment

Get a list of kubernetes volumes within the specified namespace in the given environment (Endpoint). The Endpoint ID must be a valid Portainer environment identifier. Access policy: Authenticated user.

get/kubernetes/{id}/namespaces/{namespace}/volumes

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/kubernetes/{id}/namespaces/{namespace}/volumes
  • Auth
    API key in header X-API-KEY and API key in header Authorization

Path parameters

idinteger required

Environment identifier

namespacestring required

Namespace identifier

Query parameters

withApplicationsboolean

When set to True, include the applications that are using the volumes. It is set to false by default

Response

Success

object required

Changes

No recorded changes to this operation across all 21 revisions of this API.