Skip to main content

Volumes

The /list/:cluster/volumes endpoint of the Dashium API allows you to obtain the list of Docker volumes for a specific cluster.

Use this route to retrieve details on all volumes associated with the cluster.

Endpoint​

  • Path: /list/:cluster/volumes
  • Method: GET
  • Parameters:
    • :cluster (Name of the Docker cluster)

Response​

The response from this route includes a complete list of Docker volumes associated with the specified cluster.

Each item in the list contains the following information:

  • CreatedAt: Date and time the volume was created.
  • Driver: Driver used to manage the volume (in this example, "local").
  • Labels: Labels associated with the volume.
  • Mountpoint: Mount point of the volume on the host filesystem.
  • Name: Name of the volume.
  • Options: Volume configuration options (in this example, "null" as no options specified).
  • Scope: Scope of the volume (in this example, "local").
{
  "Volumes": [
    {
        "CreatedAt": "2023-12-12T13:49:36Z",
        "Driver": "local",
        "Labels": {
            "com.docker.volume.anonymous": ""
        },
        "Mountpoint": "/var/lib/docker/volumes/VOLUME_ID/_data",
        "Name": "VOLUME_NAME",
        "Options": null,
        "Scope": "local"
    },
    {
      // Details of the second volume
    },
    // ...
  ]
}

Usage Example​

Make a GET request to this route replacing :cluster with the name of the Docker cluster you want to query.

curl -X GET https://your-dashium-api.com/list/your-cluster/volumes

Upon success, you'll receive a JSON response detailing the volumes.