Search or ask Docker

PortBinding

PortBinding schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

PortBinding represents a binding between a host IP address and a host port.
HostIp

Type: string

Host IP address that the container's port is mapped to.
All schema constraints and annotations
{
  "description": "Host IP address that the container's port is mapped to.",
  "example": "127.0.0.1",
  "type": "string",
  "x-go-type": {
    "import": {
      "package": "net/netip"
    },
    "type": "Addr"
  }
}
HostPort

Type: string

Host port number that the container's port is mapped to.
All schema constraints and annotations
{
  "description": "Host port number that the container's port is mapped to.",
  "example": "4443",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "PortBinding represents a binding between a host IP address and a host\nport.\n",
  "properties": {
    "HostIp": {
      "description": "Host IP address that the container's port is mapped to.",
      "example": "127.0.0.1",
      "type": "string",
      "x-go-type": {
        "import": {
          "package": "net/netip"
        },
        "type": "Addr"
      }
    },
    "HostPort": {
      "description": "Host port number that the container's port is mapped to.",
      "example": "4443",
      "type": "string"
    }
  },
  "type": "object"
}