Inspect a network Run in API Explorer

GET /networks/{id}

Path parameters

  • id string Required

    Network ID or name

Query parameters

  • verbose boolean

    Detailed inspect output for troubleshooting

    Default value is false.

  • scope string

    Filter the network by scope (swarm, global, or local)

Responses

  • 200 application/json

    No error

    Hide response attributes Show response attributes object
    • Name string
    • Id string
    • Created string(dateTime)
    • Scope string
    • Driver string
    • EnableIPv6 boolean
    • IPAM object
      Hide IPAM attributes Show IPAM attributes object
      • Driver string

        Name of the IPAM driver to use.

        Default value is default.

      • Config array[object]

        List of IPAM configuration options, specified as a map:

        {"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}
        Hide Config attributes Show Config attributes object
        • Subnet string
        • IPRange string
        • Gateway string
        • AuxiliaryAddresses object
          Hide AuxiliaryAddresses attribute Show AuxiliaryAddresses attribute object
          • * string Additional properties
      • Options object

        Driver-specific options, specified as a map.

        Hide Options attribute Show Options attribute object
        • * string Additional properties
    • Internal boolean
    • Attachable boolean
    • Ingress boolean
    • Containers object
      Hide Containers attribute Show Containers attribute object
      • * object Additional properties
        Hide * attributes Show * attributes object
        • Name string
        • EndpointID string
        • MacAddress string
        • IPv4Address string
        • IPv6Address string
    • Options object
      Hide Options attribute Show Options attribute object
      • * string Additional properties
    • Labels object
      Hide Labels attribute Show Labels attribute object
      • * string Additional properties
  • 404 application/json

    Network not found

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
  • 500 application/json

    Server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
GET /networks/{id} 
curl \
 --request GET 'http://api.example.com/v1.44/networks/{id}'
Response examples (200) 
{
  "Id": "7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99",
  "IPAM": {
    "Config": [
      {
        "Subnet": "172.19.0.0/16",
        "Gateway": "172.19.0.1"
      }
    ],
    "Driver": "default",
    "Options": {
      "foo": "bar"
    }
  },
  "Name": "net01",
  "Scope": "local",
  "Driver": "bridge",
  "Labels": {
    "com.example.some-label": "some-value",
    "com.example.some-other-label": "some-other-value"
  },
  "Created": "2016-10-19T04:33:30.360899459Z",
  "Ingress": false,
  "Options": {
    "com.docker.network.driver.mtu": "1500",
    "com.docker.network.bridge.name": "docker0",
    "com.docker.network.bridge.enable_icc": "true",
    "com.docker.network.bridge.default_bridge": "true",
    "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
    "com.docker.network.bridge.enable_ip_masquerade": "true"
  },
  "Internal": false,
  "Attachable": false,
  "Containers": {
    "19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c": {
      "Name": "test",
      "EndpointID": "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a",
      "MacAddress": "02:42:ac:13:00:02",
      "IPv4Address": "172.19.0.2/16",
      "IPv6Address": ""
    }
  },
  "EnableIPv6": false
}
Response examples (200) 
{
  "Id": "7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99",
  "IPAM": {
    "Config": [
      {
        "Subnet": "172.19.0.0/16",
        "Gateway": "172.19.0.1"
      }
    ],
    "Driver": "default",
    "Options": {
      "foo": "bar"
    }
  },
  "Name": "net01",
  "Scope": "local",
  "Driver": "bridge",
  "Labels": {
    "com.example.some-label": "some-value",
    "com.example.some-other-label": "some-other-value"
  },
  "Created": "2016-10-19T04:33:30.360899459Z",
  "Ingress": false,
  "Options": {
    "com.docker.network.driver.mtu": "1500",
    "com.docker.network.bridge.name": "docker0",
    "com.docker.network.bridge.enable_icc": "true",
    "com.docker.network.bridge.default_bridge": "true",
    "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
    "com.docker.network.bridge.enable_ip_masquerade": "true"
  },
  "Internal": false,
  "Attachable": false,
  "Containers": {
    "19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c": {
      "Name": "test",
      "EndpointID": "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a",
      "MacAddress": "02:42:ac:13:00:02",
      "IPv4Address": "172.19.0.2/16",
      "IPv6Address": ""
    }
  },
  "EnableIPv6": false
}
Response examples (404) 
{
  "message": "Something went wrong."
}
Response examples (404) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}