List Volumes

Retrieve all Docker volumes for a specific environment

GET /api/volumes

cURL

curl -X GET 'https://your-dockhand.com/api/volumes?env=1' \
  -H 'Cookie: session=your-session-cookie'

const response = await fetch('https://your-dockhand.com/api/volumes?env=1', {
  method: 'GET',
  credentials: 'include'
});

const volumes = await response.json();

import requests

response = requests.get(
    'https://your-dockhand.com/api/volumes',
    params={'env': 1},
    cookies={'session': 'your-session-cookie'}
)

volumes = response.json()

403 Permission Denied

{
  "error": "Permission denied"
}

{
  "error": "Access denied to this environment"
}

{
  "error": "Environment not found"
}

{
  "error": "Failed to list volumes"
}

Overview

Returns a list of all Docker volumes in the specified environment. This endpoint requires an environment ID to be provided as a query parameter.

Authentication

This endpoint requires authentication via cookies. The user must have the volumes:view permission for the specified environment.

Query Parameters

env · integer · required

The environment ID to list volumes from. Required parameter.

Response

volumes · array

Array of volume objects

Show Volume Object

Name · string

Volume name

Driver · string

Volume driver (local or third-party plugin)

Mountpoint · string

Mount point on the Docker host filesystem

CreatedAt · string

ISO 8601 timestamp of volume creation

Scope · string

Volume scope (local or global)

Labels · object

User-defined labels (key-value pairs)

Options · object

Volume driver options (key-value pairs)

UsageData · object

Volume usage statistics (if available)

Show Usage Data

Size · integer

Volume size in bytes

RefCount · integer

Number of containers using this volume

Error Responses

403 Permission Denied

{
  "error": "Permission denied"
}

{
  "error": "Access denied to this environment"
}

{
  "error": "Environment not found"
}

{
  "error": "Failed to list volumes"
}

cURL

curl -X GET 'https://your-dockhand.com/api/volumes?env=1' \
  -H 'Cookie: session=your-session-cookie'

const response = await fetch('https://your-dockhand.com/api/volumes?env=1', {
  method: 'GET',
  credentials: 'include'
});

const volumes = await response.json();

import requests

response = requests.get(
    'https://your-dockhand.com/api/volumes',
    params={'env': 1},
    cookies={'session': 'your-session-cookie'}
)

volumes = response.json()

200 Success

[
  {
    "Name": "postgres-data",
    "Driver": "local",
    "Mountpoint": "/var/lib/docker/volumes/postgres-data/_data",
    "CreatedAt": "2024-01-15T10:30:00Z",
    "Scope": "local",
    "Labels": {
      "app": "database",
      "environment": "production"
    },
    "Options": {},
    "UsageData": {
      "Size": 5368709120,
      "RefCount": 1
    }
  },
  {
    "Name": "shared-storage",
    "Driver": "local",
    "Mountpoint": "/var/lib/docker/volumes/shared-storage/_data",
    "CreatedAt": "2024-01-20T14:22:00Z",
    "Scope": "local",
    "Labels": {
      "app": "file-server",
      "tier": "storage"
    },
    "Options": {
      "type": "nfs",
      "device": ":/data/shared",
      "o": "addr=192.168.1.100,rw,nfsvers=4"
    },
    "UsageData": {
      "Size": 10737418240,
      "RefCount": 3
    }
  },
  {
    "Name": "temp-cache",
    "Driver": "local",
    "Mountpoint": "/var/lib/docker/volumes/temp-cache/_data",
    "CreatedAt": "2024-02-01T09:15:00Z",
    "Scope": "local",
    "Labels": {},
    "Options": {
      "type": "tmpfs",
      "device": "tmpfs",
      "o": "size=1G,mode=1777"
    },
    "UsageData": {
      "Size": 524288000,
      "RefCount": 1
    }
  }
]

Notes

• Returns an empty array if no environment ID is provided
• Volume data is retrieved directly from the Docker API
• Requires authentication to be enabled and the user to have proper permissions
• Enterprise users must have access to the specified environment
• UsageData may not be available for all volume drivers
• Volumes created by Docker Compose will include stack labels