List Networks

Retrieve all Docker networks for a specific environment

GET /api/networks

cURL

curl -X GET 'https://your-dockhand.com/api/networks?env=1' \
  -H 'Cookie: session=your-session-cookie'

const response = await fetch('https://your-dockhand.com/api/networks?env=1', {
  method: 'GET',
  credentials: 'include'
});

const networks = await response.json();

import requests

response = requests.get(
    'https://your-dockhand.com/api/networks',
    params={'env': 1},
    cookies={'session': 'your-session-cookie'}
)

networks = response.json()

403 Permission Denied

{
  "error": "Permission denied"
}

{
  "error": "Access denied to this environment"
}

{
  "error": "Environment not found"
}

{
  "error": "Failed to list networks"
}

Overview

Returns a list of all Docker networks in the specified environment. This endpoint requires an environment ID to be provided as a query parameter.

Authentication

This endpoint requires authentication via cookies. The user must have the networks:view permission for the specified environment.

Query Parameters

env · integer · required

The environment ID to list networks from. Required parameter.

Response

networks · array

Array of network objects

Show Network Object

Id · string

Unique network identifier

Name · string

Network name

Driver · string

Network driver type (bridge, host, overlay, macvlan, ipvlan, none)

Scope · string

Network scope (local, swarm, global)

Internal · boolean

Whether the network is internal-only (no external connectivity)

Attachable · boolean

Whether the network is attachable to standalone containers

Ingress · boolean

Whether this is a swarm ingress network

EnableIPv6 · boolean

Whether IPv6 is enabled on the network

IPAM · object

IP Address Management configuration

Show IPAM Object

Driver · string

IPAM driver name (default: “default”)

Config · array

Array of IPAM configuration objects

Show Config Object

Subnet · string

Network subnet in CIDR notation (e.g., “172.18.0.0/16”)

Gateway · string

Gateway IP address

IPRange · string

IP range for container allocation

Options · object

IPAM driver-specific options

Containers · object

Map of container IDs to container network information

Options · object

Network driver options (key-value pairs)

Labels · object

User-defined labels (key-value pairs)

Error Responses

403 Permission Denied

{
  "error": "Permission denied"
}

{
  "error": "Access denied to this environment"
}

{
  "error": "Environment not found"
}

{
  "error": "Failed to list networks"
}

cURL

curl -X GET 'https://your-dockhand.com/api/networks?env=1' \
  -H 'Cookie: session=your-session-cookie'

const response = await fetch('https://your-dockhand.com/api/networks?env=1', {
  method: 'GET',
  credentials: 'include'
});

const networks = await response.json();

import requests

response = requests.get(
    'https://your-dockhand.com/api/networks',
    params={'env': 1},
    cookies={'session': 'your-session-cookie'}
)

networks = response.json()

200 Success

[
  {
    "Id": "c7b9a6e5f8d3",
    "Name": "app-network",
    "Driver": "bridge",
    "Scope": "local",
    "Internal": false,
    "Attachable": false,
    "Ingress": false,
    "EnableIPv6": false,
    "IPAM": {
      "Driver": "default",
      "Config": [
        {
          "Subnet": "172.18.0.0/16",
          "Gateway": "172.18.0.1",
          "IPRange": "172.18.5.0/24"
        }
      ],
      "Options": {}
    },
    "Containers": {
      "a1b2c3d4e5f6": {
        "Name": "web-server",
        "IPv4Address": "172.18.5.10/16",
        "IPv6Address": "",
        "MacAddress": "02:42:ac:12:05:0a"
      }
    },
    "Options": {
      "com.docker.network.bridge.name": "br-app",
      "com.docker.network.bridge.enable_icc": "true"
    },
    "Labels": {
      "app": "myapp",
      "environment": "production"
    }
  },
  {
    "Id": "bridge",
    "Name": "bridge",
    "Driver": "bridge",
    "Scope": "local",
    "Internal": false,
    "Attachable": false,
    "Ingress": false,
    "EnableIPv6": false,
    "IPAM": {
      "Driver": "default",
      "Config": [
        {
          "Subnet": "172.17.0.0/16",
          "Gateway": "172.17.0.1"
        }
      ],
      "Options": null
    },
    "Containers": {},
    "Options": {},
    "Labels": {}
  }
]

Notes

• Returns an empty array if no environment ID is provided
• Built-in networks (bridge, host, none) are always included in the response
• Requires authentication to be enabled and the user to have proper permissions
• Enterprise users must have access to the specified environment
• Network data is retrieved directly from the Docker API