Skip to main content

Clusters

The /list/cluster endpoint of the Dashium API allows you to retrieve the list of registered Docker clusters.

This route fetches details such as the name, icon, host, port, and other information for each cluster.

Endpoint​

  • Path: /list/cluster
  • Method: GET

Response​

The response of this route includes a detailed list of all clusters registered in the database.

Each item in the list contains the following information:

  • id: Unique identifier of the cluster.
  • name: Name of the cluster.
  • fullname: Full name of the cluster with a possible icon.
  • icon: Icon representing the cluster.
  • host: Docker host address.
  • port: Port for accessing the Docker host.
  • docker: Detailed information about the Docker instance of the cluster, including the number of volumes.
{
  "clusters": [
    {
      "id": 1,
      "name": "ClusterName1",
      "fullname": "💎 ClusterName1",
      "icon": "💎",
      "host": "localhost",
      "port": 2376,
      "docker": {
        // Detailed information about the Docker instance of the cluster
      }
    },
    {
      // ...
    },
    // ...
  ]
}

Usage Example​

Perform a GET request to this route to retrieve the list of registered clusters.

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

Upon success, you will receive a JSON response detailing the clusters.