Skip to main content

Networks

The /list/:cluster/networks endpoint of the Dashium API allows you to retrieve the list of Docker networks for a specific cluster.

Use this route to fetch details about all networks associated with the cluster.

Endpoint​

  • Path: /list/:cluster/networks
  • Method: GET
  • Parameters:
    • :cluster (Name of the Docker cluster)

Response​

The response from this route includes a complete list of Docker networks associated with the specified cluster.

{
  "networks": [
    {
      "Name": "bridge",
      "Id": "NETWORK_ID",
      "Created": "2023-12-13T12:25:21.766154509Z",
      "Scope": "local",
      "Driver": "bridge",
      "EnableIPv6": false,
      "IPAM": {
        "Driver": "default",
        "Options": null,
        "Config": [
          {
            "Subnet": "SUBNET/16",
            "Gateway": "GATEWAY"
          }
        ]
      },
      "Internal": false,
      "Attachable": false,
      "Ingress": false,
      "ConfigFrom": {
        "Network": ""
      },
      "ConfigOnly": false,
      "Containers": {},
      "Options": {
        "com.docker.network.bridge.default_bridge": "true",
        "com.docker.network.bridge.enable_icc": "true",
        "com.docker.network.bridge.enable_ip_masquerade": "true",
        "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
        "com.docker.network.bridge.name": "docker0",
        "com.docker.network.driver.mtu": "1500"
      },
      "Labels": {}
    },
    {
      // ...
    },
    // ...
  ]
}

Usage Example​

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

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

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