Skip to main content

Network

The /detail/:cluster/network/:networkName endpoint of the Dashium API provides detailed information about a specific Docker network.

Use this route to retrieve details about the network, including its configuration and connected containers.

Endpoint​

  • Path: /detail/:cluster/network/:networkName
  • Method: GET
  • Parameters:
    • :cluster (Docker cluster identifier)
    • :networkName (Name of the Docker network)

Response​

The response includes detailed information about the specified Docker network.

Response Example​

{
    "Name": "NETWORK_NAME",
    "Id": "NETWORK_ID",
    "Created": "2023-12-10T21:23:54.946616826Z",
    "Scope": "local",
    "Driver": "bridge",
    "EnableIPv6": false,
    "IPAM": {
        "Driver": "default",
        "Config": [
            {
                "Subnet": "SUBNET/16",
                "Gateway": "GATEWAY"
            }
        ]
    },
    "Internal": false,
    "Attachable": false,
    "Ingress": 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": {}
}

Example​

fetch('http://your-api-url/detail/your-cluster/network/your-network')
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error(error));