Skip to main content

Volume

The /detail/:cluster/volume/:volumeName endpoint of the Dashium API provides detailed information about a specific Docker volume.

Use this route to retrieve volume details, including its configuration and usage.

Endpoint​

  • Path: /detail/:cluster/volume/:volumeName
  • Method: GET
  • Parameters:
    • :cluster (Docker cluster identifier)
    • :volumeName (Docker volume name)

Response​

The response includes detailed information about the specified Docker volume.

Response Example​

{
    "Name": "VOLUME_NAME",
    "Driver": "local",
    "Mountpoint": "/path/to/mount/point",
    "CreatedAt": "2023-12-10T21:23:54.946616826Z",
    "Status": {
        "Volume": "VOLUME_ID",
        "Type": "local"
    },
    "Labels": {
        "com.example.some-label": "some-value"
    }
}

Example​

fetch('http://your-api-url/detail/your-cluster/volume/your-volume')
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error(error));