Search or ask Docker

NetworkingConfig

NetworkingConfig schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.
EndpointsConfig

Type: object

A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration.
All schema constraints and annotations
{
  "additionalProperties": {
    "$ref": "#/components/schemas/EndpointSettings"
  },
  "description": "A mapping of network name to endpoint configuration for that network.\nThe endpoint configuration can be left empty to connect to that\nnetwork with no particular endpoint configuration.\n",
  "type": "object"
}
All schema constraints and annotations
{
  "description": "NetworkingConfig represents the container's networking configuration for\neach of its interfaces.\nIt is used for the networking configs specified in the `docker create`\nand `docker network connect` commands.\n",
  "example": {
    "EndpointsConfig": {
      "database_nw": {},
      "isolated_nw": {
        "Aliases": [
          "server_x",
          "server_y"
        ],
        "IPAMConfig": {
          "IPv4Address": "172.20.30.33",
          "IPv6Address": "2001:db8:abcd::3033",
          "LinkLocalIPs": [
            "169.254.34.68",
            "fe80::3468"
          ]
        },
        "Links": [
          "container_1",
          "container_2"
        ],
        "MacAddress": "02:42:ac:12:05:02"
      }
    }
  },
  "properties": {
    "EndpointsConfig": {
      "additionalProperties": {
        "$ref": "#/components/schemas/EndpointSettings"
      },
      "description": "A mapping of network name to endpoint configuration for that network.\nThe endpoint configuration can be left empty to connect to that\nnetwork with no particular endpoint configuration.\n",
      "type": "object"
    }
  },
  "type": "object"
}