Sign in

v1

latestSwagger 2.02026-07-17107114423.2 KB
Network

Create a network

post/networks/create

Request body

Namestring required

The network's name.

Driverstring

Name of the network driver plugin to use.

Scopestring

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

Internalboolean

Restrict external access to the network.

Attachableboolean

Globally scoped network is manually attachable by regular containers from workers in swarm mode.

Ingressboolean

Ingress network is the network which provides the routing-mesh in swarm mode.

ConfigOnlyboolean

Creates 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.

EnableIPv6boolean

Enable IPv6 on the network.

Optionsobject

Network specific options to be used by the drivers.

Labelsobject

User-defined key/value metadata.

Example request

{
  "Name": "my_network",
  "Driver": "bridge",
  "Attachable": true,
  "ConfigFrom": {
    "Network": "config_only_network_01"
  },
  "IPAM": {
    "Driver": "default",
    "Config": [
      {
        "Subnet": "172.20.0.0/16",
        "IPRange": "172.20.10.0/24",
        "Gateway": "172.20.10.11"
      }
    ],
    "Options": {
      "foo": "bar"
    }
  },
  "EnableIPv6": true,
  "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"
  }
}

Response

Network created successfully

Idstring required

The ID of the created network.

Warningstring required

Warnings encountered when creating the container

Example response

{
  "Id": "b5c4fc71e8022147cd25de22b22173de4e3b170134117172eb595cb91b4e7e5d"
}