Search or ask Docker

EndpointPortConfig

EndpointPortConfig schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Name

Type: string

All schema constraints and annotations
{
  "type": "string"
}
Protocol

Type: string

All schema constraints and annotations
{
  "enum": [
    "tcp",
    "udp",
    "sctp"
  ],
  "type": "string"
}
PublishMode

Type: string

The mode in which port is published.


  • "ingress" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not.
  • "host" bypasses the routing mesh and publish the port directly on the swarm node where that service is running.
All schema constraints and annotations
{
  "default": "ingress",
  "description": "The mode in which port is published.\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n- \"ingress\" makes the target port accessible on every node,\n  regardless of whether there is a task for the service running on\n  that node or not.\n- \"host\" bypasses the routing mesh and publish the port directly on\n  the swarm node where that service is running.\n",
  "enum": [
    "ingress",
    "host"
  ],
  "example": "ingress",
  "type": "string"
}
PublishedPort

Type: integer

The port on the swarm hosts.
All schema constraints and annotations
{
  "description": "The port on the swarm hosts.",
  "type": "integer"
}
TargetPort

Type: integer

The port inside the container.
All schema constraints and annotations
{
  "description": "The port inside the container.",
  "type": "integer"
}
All schema constraints and annotations
{
  "properties": {
    "Name": {
      "type": "string"
    },
    "Protocol": {
      "enum": [
        "tcp",
        "udp",
        "sctp"
      ],
      "type": "string"
    },
    "PublishMode": {
      "default": "ingress",
      "description": "The mode in which port is published.\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n- \"ingress\" makes the target port accessible on every node,\n  regardless of whether there is a task for the service running on\n  that node or not.\n- \"host\" bypasses the routing mesh and publish the port directly on\n  the swarm node where that service is running.\n",
      "enum": [
        "ingress",
        "host"
      ],
      "example": "ingress",
      "type": "string"
    },
    "PublishedPort": {
      "description": "The port on the swarm hosts.",
      "type": "integer"
    },
    "TargetPort": {
      "description": "The port inside the container.",
      "type": "integer"
    }
  },
  "type": "object"
}