Search or ask Docker

EndpointIPAMConfig

EndpointIPAMConfig schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

EndpointIPAMConfig represents an endpoint's IPAM configuration.
IPv4Address

Type: string

All schema constraints and annotations
{
  "example": "172.20.30.33",
  "type": "string",
  "x-go-type": {
    "import": {
      "package": "net/netip"
    },
    "type": "Addr"
  }
}
IPv6Address

Type: string

All schema constraints and annotations
{
  "example": "2001:db8:abcd::3033",
  "type": "string",
  "x-go-type": {
    "import": {
      "package": "net/netip"
    },
    "type": "Addr"
  }
}
LinkLocalIPs

Type: array

Array item

Type: string

All schema constraints and annotations
{
  "type": "string",
  "x-go-type": {
    "import": {
      "package": "net/netip"
    },
    "type": "Addr"
  }
}
All schema constraints and annotations
{
  "example": [
    "169.254.34.68",
    "fe80::3468"
  ],
  "items": {
    "type": "string",
    "x-go-type": {
      "import": {
        "package": "net/netip"
      },
      "type": "Addr"
    }
  },
  "type": "array"
}
All schema constraints and annotations
{
  "description": "EndpointIPAMConfig represents an endpoint's IPAM configuration.\n",
  "properties": {
    "IPv4Address": {
      "example": "172.20.30.33",
      "type": "string",
      "x-go-type": {
        "import": {
          "package": "net/netip"
        },
        "type": "Addr"
      }
    },
    "IPv6Address": {
      "example": "2001:db8:abcd::3033",
      "type": "string",
      "x-go-type": {
        "import": {
          "package": "net/netip"
        },
        "type": "Addr"
      }
    },
    "LinkLocalIPs": {
      "example": [
        "169.254.34.68",
        "fe80::3468"
      ],
      "items": {
        "type": "string",
        "x-go-type": {
          "import": {
            "package": "net/netip"
          },
          "type": "Addr"
        }
      },
      "type": "array"
    }
  },
  "type": "object",
  "x-nullable": true
}