Search or ask Docker

PortMap

PortMap schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format <port>/<protocol>, for example, 80/udp.

If a container's port is mapped for multiple protocols, separate entries are added to the mapping table.

All schema constraints and annotations
{
  "additionalProperties": {
    "items": {
      "$ref": "#/components/schemas/PortBinding"
    },
    "type": "array",
    "x-nullable": true
  },
  "description": "PortMap describes the mapping of container ports to host ports, using the\ncontainer's port-number and protocol as key in the format `\u003cport\u003e/\u003cprotocol\u003e`,\nfor example, `80/udp`.\n\nIf a container's port is mapped for multiple protocols, separate entries\nare added to the mapping table.\n",
  "example": {
    "2377/tcp": null,
    "443/tcp": [
      {
        "HostIp": "127.0.0.1",
        "HostPort": "4443"
      }
    ],
    "53/udp": [
      {
        "HostIp": "0.0.0.0",
        "HostPort": "53"
      }
    ],
    "80/tcp": [
      {
        "HostIp": "0.0.0.0",
        "HostPort": "80"
      },
      {
        "HostIp": "0.0.0.0",
        "HostPort": "8080"
      }
    ],
    "80/udp": [
      {
        "HostIp": "0.0.0.0",
        "HostPort": "80"
      }
    ]
  },
  "type": "object"
}