Search or ask Docker

EndpointSpec

EndpointSpec schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Properties that can be configured to access and load balance a service.
Mode

Type: string

The mode of resolution to use for internal load balancing between tasks.
All schema constraints and annotations
{
  "default": "vip",
  "description": "The mode of resolution to use for internal load balancing between tasks.\n",
  "enum": [
    "vip",
    "dnsrr"
  ],
  "type": "string"
}
Ports

Type: array

List of exposed ports that this service is accessible on from the outside. Ports can only be provided if vip resolution mode is used.
Array item

Schema: EndpointPortConfig

All schema constraints and annotations
{
  "description": "List of exposed ports that this service is accessible on from the\noutside. Ports can only be provided if `vip` resolution mode is used.\n",
  "items": {
    "$ref": "#/components/schemas/EndpointPortConfig"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "description": "Properties that can be configured to access and load balance a service.",
  "properties": {
    "Mode": {
      "default": "vip",
      "description": "The mode of resolution to use for internal load balancing between tasks.\n",
      "enum": [
        "vip",
        "dnsrr"
      ],
      "type": "string"
    },
    "Ports": {
      "description": "List of exposed ports that this service is accessible on from the\noutside. Ports can only be provided if `vip` resolution mode is used.\n",
      "items": {
        "$ref": "#/components/schemas/EndpointPortConfig"
      },
      "type": "array"
    }
  },
  "type": "object"
}