Skip to main content

Cluster

The /detail/cluster/:clusterid endpoint of the Dashium API allows you to get details about a specific Docker cluster.

Use this route to access detailed information about a cluster, including associated Docker details.

Endpoint​

  • Path: /detail/cluster/:clusterid
  • Method: GET
  • Parameters:
    • :clusterid (Docker cluster ID)

Response​

The response from this route includes details of the specified Docker cluster, including associated Docker information.

{
  "cluster": {
    "id": 1,
    "name": "Cluster Name",
    "fullname": "Full Cluster Name",
    "icon": "🚀",
    "host": "localhost",
    "port": 2375
    // Other cluster details
  },
  "docker": {
    // Associated Docker information
  }
}
  • id: Cluster ID
  • name: Cluster name
  • fullname: Full cluster name
  • icon: Cluster icon
  • host: Cluster host address
  • port: Cluster port
  • docker: Associated Docker information, including volume count

Usage Example​

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

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

Upon success, you'll receive a JSON response indicating details of the specified cluster.