Skip to main content

📖 Detail

The /detail endpoint of the Dashium API allows you to obtain details about Docker clusters, containers, images, volumes, and networks.

Use this route to access detailed information about Docker elements within a specific cluster.

Endpoint​

  • Path: /detail
  • Method: GET

Response​

The response from this route includes a list of available sub-routes to get specific details about Docker elements.

{
  "routes": [
    { "path": "/detail/cluster/:clusterid", "methods": ["GET"], "params": ["clusterid"] },
    { "path": "/detail/:cluster/container/:containerName", "methods": ["GET"], "params": ["cluster", "containerName"] },
    { "path": "/detail/:cluster/container/:containerName/attach", "methods": ["GET"], "params": ["cluster", "containerName"] },
    { "path": "/detail/:cluster/container/:containerName/process", "methods": ["GET"], "params": ["cluster", "containerName"] },
    { "path": "/detail/:cluster/container/:containerName/logs", "methods": ["GET"], "params": ["cluster", "containerName"] },
    { "path": "/detail/:cluster/container/:containerName/stats", "methods": ["GET"], "params": ["cluster", "containerName"] },
    { "path": "/detail/:cluster/image/:imageName", "methods": ["GET"], "params": ["cluster", "imageName"] },
    { "path": "/detail/:cluster/volume/:volumeName", "methods": ["GET"], "params": ["cluster", "volumeName"] },
    { "path": "/detail/:cluster/network/:networkName", "methods": ["GET"], "params": ["cluster", "networkName"] }
  ]
}

Usage Example​

Make a GET request to this route to obtain the list of available sub-routes.

curl -X GET https://your-dashium-api.com/detail

Upon success, you will receive a JSON response indicating the available routes to get details about Docker elements.