HEhexlet
Network

Inspect a network

Changed on
get/networks/{id}

Request

  • Base URL
    /v1.57 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Path parameters

idstring required

Network ID or name

Query parameters

verboseboolean

Detailed inspect output for troubleshooting

scopestring

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

Response

No error

Namestring

Name of the network.

Idstring

ID that uniquely identifies a network on a single machine.

Createdstring dateTime

Date and time at which the network was created in RFC 3339 format with nano-seconds.

Scopestring

The level at which the network exists (e.g. swarm for cluster-wide or local for machine level)

Driverstring

The name of the driver used to create the network (e.g. bridge, overlay).

EnableIPv4boolean

Whether the network was created with IPv4 enabled.

EnableIPv6boolean

Whether the network was created with IPv6 enabled.

Internalboolean

Whether the network is created to only allow internal networking connectivity.

Attachableboolean

Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode.

Ingressboolean

Whether the network is providing the routing-mesh for the swarm cluster.

ConfigOnlyboolean

Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services.

Optionsobject

Network-specific options uses when creating the network.

Labelsobject

Metadata specific to the network being created.

Example response

{
  "Name": "my_network",
  "Id": "7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99",
  "Created": "2016-10-19T04:33:30.360899459Z",
  "Scope": "local",
  "Driver": "overlay",
  "EnableIPv4": true,
  "IPAM": {
    "Driver": "default",
    "Config": [
      {
        "Subnet": "172.20.0.0/16",
        "IPRange": "172.20.10.0/24",
        "Gateway": "172.20.10.11"
      }
    ],
    "Options": {
      "foo": "bar"
    }
  },
  "ConfigFrom": {
    "Network": "config_only_network_01"
  },
  "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": {
    "com.example.some-label": "some-value",
    "com.example.some-other-label": "some-other-value"
  },
  "Peers": [
    {
      "Name": "6869d7c1732b",
      "IP": "10.133.77.91"
    }
  ]
}

Changes

  • 6df97b60796cRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      api operation id NetworkInspectOp removed and replaced with NetworkInspect

    • info

      api tag Network added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 31f80d10d31aRevision changes
    • breaking

      for the query request parameter verbose, default value false was removed

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id NetworkInspect removed and replaced with NetworkInspectOp

    • info

      api tag Network removed

    • info

      removed from the response body allOf list for the response status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status