# EndpointSettings


[API catalog](/reference/api/) · [Docker Engine overview](/reference/api/engine/version/v1.57/) · [Product manual](https://docs.docker.com/engine/) · [OpenAPI specification](/reference/api/engine/version/v1.57.yaml)

API version: 1.57





Schema constraints and annotations:

```json
{
  "description": "Configuration for a network endpoint.",
  "properties": {
    "Aliases": {
      "example": [
        "server_x",
        "server_y"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "DNSNames": {
      "description": "List of all DNS names an endpoint has on a specific network. This\nlist is based on the container name, network aliases, container short\nID, and hostname.\n\nThese DNS names are non-fully qualified but can contain several dots.\nYou can get fully qualified DNS names by appending `.\u003cnetwork-name\u003e`.\nFor instance, if container name is `my.ctr` and the network is named\n`testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be\n`my.ctr.testnet`.\n",
      "example": [
        "foobar",
        "server_x",
        "server_y",
        "my.ctr"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "DriverOpts": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "DriverOpts is a mapping of driver options and values. These options\nare passed directly to the driver and are driver specific.\n",
      "example": {
        "com.example.some-label": "some-value",
        "com.example.some-other-label": "some-other-value"
      },
      "type": "object",
      "x-nullable": true
    },
    "EndpointID": {
      "description": "Unique ID for the service endpoint in a Sandbox.\n",
      "example": "b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b",
      "type": "string"
    },
    "Gateway": {
      "description": "Gateway address for this network.\n",
      "example": "172.17.0.1",
      "type": "string"
    },
    "GlobalIPv6Address": {
      "description": "Global IPv6 address.\n",
      "example": "2001:db8::5689",
      "type": "string",
      "x-go-type": {
        "import": {
          "package": "net/netip"
        },
        "type": "Addr"
      }
    },
    "GlobalIPv6PrefixLen": {
      "description": "Mask length of the global IPv6 address.\n",
      "example": 64,
      "format": "int64",
      "type": "integer"
    },
    "GwPriority": {
      "description": "This property determines which endpoint will provide the default\ngateway for a container. The endpoint with the highest priority will\nbe used. If multiple endpoints have the same priority, endpoints are\nlexicographically sorted based on their network name, and the one\nthat sorts first is picked.\n",
      "example": [
        10
      ],
      "format": "int64",
      "type": "integer"
    },
    "IPAMConfig": {
      "$ref": "#/components/schemas/EndpointIPAMConfig"
    },
    "IPAddress": {
      "description": "IPv4 address.\n",
      "example": "172.17.0.4",
      "type": "string",
      "x-go-type": {
        "import": {
          "package": "net/netip"
        },
        "type": "Addr"
      }
    },
    "IPPrefixLen": {
      "description": "Mask length of the IPv4 address.\n",
      "example": 16,
      "type": "integer"
    },
    "IPv6Gateway": {
      "description": "IPv6 gateway address.\n",
      "example": "2001:db8:2::100",
      "type": "string",
      "x-go-type": {
        "import": {
          "package": "net/netip"
        },
        "type": "Addr"
      }
    },
    "Links": {
      "example": [
        "container_1",
        "container_2"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "MacAddress": {
      "description": "MAC address for the endpoint on this network. The network driver might ignore this parameter.\n",
      "example": "02:42:ac:11:00:04",
      "type": "string",
      "x-go-type": {
        "type": "HardwareAddr"
      }
    },
    "NetworkID": {
      "description": "Unique ID of the network.\n",
      "example": "08754567f1f40222263eab4102e1c733ae697e8e354aa9cd6e18d7402835292a",
      "type": "string"
    }
  },
  "type": "object"
}
```



