Docker Engine API
  1. Network
Docker Engine API
  • System
    • Ping
      GET
    • Check auth configuration
      POST
    • Monitor events
      GET
    • Get system information
      GET
    • Get data usage information
      GET
    • Get version
      GET
  • Image
    • Build an image
      POST
    • Delete builder cache
      POST
    • Create a new image from a container
      POST
    • Create an image
      POST
    • Export several images
      GET
    • List Images
      GET
    • Import images
      POST
    • Delete unused images
      POST
    • Search images
      GET
    • Remove an image
      DELETE
    • Export an image
      GET
    • Get the history of an image
      GET
    • Inspect an image
      GET
    • Push an image
      POST
    • Tag an image
      POST
  • Config
    • List configs
    • Create a config
    • Delete a config
    • Inspect a config
    • Update a Config
  • Container
    • Create a container
    • List containers
    • Delete stopped containers
    • Remove a container
    • Get an archive of a filesystem resource in a container
    • Get information about files in a container
    • Extract an archive of files or folders to a directory in a container
    • Attach to a container
    • Attach to a container via a websocket
    • Get changes on a container’s filesystem
    • Export a container
    • Inspect a container
    • Kill a container
    • Get container logs
    • Pause a container
    • Rename a container
    • Resize a container TTY
    • Restart a container
    • Start a container
    • Get container stats based on resource usage
    • Stop a container
    • List processes running inside a container
    • Unpause a container
    • Update a container
    • Wait for a container
  • Exec
    • Create an exec instance
    • Inspect an exec instance
    • Resize an exec instance
    • Start an exec instance
  • Distribution
    • Get image information from the registry
  • Network
    • List networks
      GET
    • Create a network
      POST
    • Delete unused networks
      POST
    • Remove a network
      DELETE
    • Inspect a network
      GET
    • Connect a container to a network
      POST
    • Disconnect a container from a network
      POST
  • Node
    • List nodes
    • Delete a node
    • Inspect a node
    • Update a node
  • Plugin
    • List plugins
    • Create a plugin
    • Get plugin privileges
    • Install a plugin
    • Remove a plugin
    • Disable a plugin
    • Enable a plugin
    • Inspect a plugin
    • Push a plugin
    • Configure a plugin
    • Upgrade a plugin
  • Secret
    • List secrets
    • Create a secret
    • Delete a secret
    • Inspect a secret
    • Update a Secret
  • Service
    • List services
    • Create a service
    • Delete a service
    • Inspect a service
    • Get service logs
    • Update a service
  • Session (experimental)
    • Initialize interactive session
  • Swarm
    • Inspect swarm
    • Initialize a new swarm
    • Join an existing swarm
    • Leave a swarm
    • Unlock a locked manager
    • Get the unlock key
    • Update a swarm
  • Task
    • List tasks
    • Inspect a task
  • Volume
    • List volumes
    • Create a volume
    • Delete unused volumes
    • Remove a volume
    • Inspect a volume
  • Get task logs
    GET
  1. Network

Inspect a network

/v1.33
/v1.33
/v1.33
/v1.33
GET
/networks/{id}
Network
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.33/networks/'
Response Response Example
200 - Example 1
{
    "Attachable": false,
    "Containers": {
        "19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c": {
            "EndpointID": "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a",
            "IPv4Address": "172.19.0.2/16",
            "IPv6Address": "",
            "MacAddress": "02:42:ac:13:00:02",
            "Name": "test"
        }
    },
    "Created": "2016-10-19T04:33:30.360899459Z",
    "Driver": "bridge",
    "EnableIPv6": false,
    "IPAM": {
        "Config": [
            {
                "Gateway": "172.19.0.1",
                "Subnet": "172.19.0.0/16"
            }
        ],
        "Driver": "default",
        "Options": {
            "foo": "bar"
        }
    },
    "Id": "7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99",
    "Ingress": false,
    "Internal": false,
    "Labels": {
        "com.example.some-label": "some-value",
        "com.example.some-other-label": "some-other-value"
    },
    "Name": "net01",
    "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"
}

Request

Path Params
id
string 
required
Network ID or name
Query Params
verbose
string 
optional
Detailed inspect output for troubleshooting
scope
string 
optional
Filter the network by scope (swarm, global, or local)

Responses

🟢200No error
application/json
Body
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.
Id
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
🟠404Network not found
🔴500Server error
Modified at 2022-09-10 17:56:06
Previous
Remove a network
Next
Connect a container to a network
Built with