List networks

/v1.33

GET

/networks

Network

Returns a list of networks. For details on the format, see the network inspect endpoint.

Note that it uses a different, smaller representation of a network than inspecting a single network. For example,
the list of containers attached to the network is not propagated in API versions 1.28 and up.

Response Example

200 - response

[
    {
        "Attachable": false,
        "Created": "2016-10-19T06:21:00.416543526Z",
        "Driver": "bridge",
        "EnableIPv6": false,
        "IPAM": {
            "Config": [
                {
                    "Subnet": "172.17.0.0/16"
                }
            ],
            "Driver": "default"
        },
        "Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566",
        "Ingress": false,
        "Internal": false,
        "Name": "bridge",
        "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"
        },
        "Scope": "local"
    },
    {
        "Attachable": false,
        "Containers": {},
        "Created": "0001-01-01T00:00:00Z",
        "Driver": "null",
        "EnableIPv6": false,
        "IPAM": {
            "Config": [],
            "Driver": "default"
        },
        "Id": "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794",
        "Ingress": false,
        "Internal": false,
        "Name": "none",
        "Options": {},
        "Scope": "local"
    },
    {
        "Attachable": false,
        "Containers": {},
        "Created": "0001-01-01T00:00:00Z",
        "Driver": "host",
        "EnableIPv6": false,
        "IPAM": {
            "Config": [],
            "Driver": "default"
        },
        "Id": "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e",
        "Ingress": false,
        "Internal": false,
        "Name": "host",
        "Options": {},
        "Scope": "local"
    }
]

Request

Query Params

filters

string

optional

JSON encoded value of the filters (a map[string][]string) to process on the networks list. Available filters:

driver=<driver-name> Matches a network's driver.

id=<network-id> Matches all or part of a network ID.

label=<key> or label=<key>=<value> of a network label.

name=<network-name> Matches all or part of a network name.

scope=["swarm"|"global"|"local"] Filters networks by scope (swarm, global, or local).

type=["custom"|"builtin"] Filters networks by type. The custom keyword returns all user-defined networks.

Responses

🟢200No error

application/json

Body

array of:

Attachable

boolean

optional

Containers

object

optional

Additional properties

object (NetworkContainer)

optional

Created

string <dateTime>

optional

Driver

string

optional

EnableIPv6

boolean

optional

IPAM

object (IPAM)

optional

Config

array [object {1}]

optional

List of IPAM configuration options, specified as a map: {"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}

Driver

string

optional

Name of the IPAM driver to use.

Default:

default

Options

array [object {1}]

optional

Driver-specific options, specified as a map.

string

optional

Ingress

boolean

optional

Internal

boolean

optional

Labels

object

optional

Additional properties

string

optional

Name

string

optional

Options

object

optional

Additional properties

string

optional

Scope

string

optional

🔴500Server error

Modified at 2022-09-10 17:56:06

Get image information from the registry

Create a network