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

Create a network

/v1.33
/v1.33
/v1.33
/v1.33
POST
/networks/create
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1.33/networks/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Attachable": false,
    "CheckDuplicate": false,
    "Driver": "bridge",
    "EnableIPv6": true,
    "IPAM": {
        "Config": [
            {
                "Gateway": "172.20.10.11",
                "IPRange": "172.20.10.0/24",
                "Subnet": "172.20.0.0/16"
            },
            {
                "Gateway": "2001:db8:abcd::1011",
                "Subnet": "2001:db8:abcd::/64"
            }
        ],
        "Driver": "default",
        "Options": {
            "foo": "bar"
        }
    },
    "Ingress": false,
    "Internal": true,
    "Labels": {
        "com.example.some-label": "some-value",
        "com.example.some-other-label": "some-other-value"
    },
    "Name": "isolated_nw",
    "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"
    }
}'
Response Response Example
201 - Example 1
{
    "Id": "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30",
    "Warning": ""
}

Request

Body Params application/json

Examples

Responses

🟢201No error
application/json
Body

🟠403operation not supported for pre-defined networks
🟠404plugin not found
🔴500Server error
Modified at 2022-09-10 17:56:06
Previous
List networks
Next
Delete unused networks
Built with