Search or ask Docker

EndpointResource

EndpointResource schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

contains network resources allocated and used for a container in a network.
EndpointID

Type: string

All schema constraints and annotations
{
  "example": "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a",
  "type": "string",
  "x-omitempty": false
}
IPv4Address

Type: string

All schema constraints and annotations
{
  "example": "172.19.0.2/16",
  "type": "string",
  "x-go-type": {
    "import": {
      "package": "net/netip"
    },
    "type": "Prefix"
  },
  "x-omitempty": false
}
IPv6Address

Type: string

All schema constraints and annotations
{
  "example": "",
  "type": "string",
  "x-go-type": {
    "import": {
      "package": "net/netip"
    },
    "type": "Prefix"
  },
  "x-omitempty": false
}
MacAddress

Type: string

All schema constraints and annotations
{
  "example": "02:42:ac:13:00:02",
  "type": "string",
  "x-go-type": {
    "type": "HardwareAddr"
  },
  "x-omitempty": false
}
Name

Type: string

All schema constraints and annotations
{
  "example": "container_1",
  "type": "string",
  "x-omitempty": false
}
All schema constraints and annotations
{
  "description": "contains network resources allocated and used for a container in a network.\n",
  "properties": {
    "EndpointID": {
      "example": "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a",
      "type": "string",
      "x-omitempty": false
    },
    "IPv4Address": {
      "example": "172.19.0.2/16",
      "type": "string",
      "x-go-type": {
        "import": {
          "package": "net/netip"
        },
        "type": "Prefix"
      },
      "x-omitempty": false
    },
    "IPv6Address": {
      "example": "",
      "type": "string",
      "x-go-type": {
        "import": {
          "package": "net/netip"
        },
        "type": "Prefix"
      },
      "x-omitempty": false
    },
    "MacAddress": {
      "example": "02:42:ac:13:00:02",
      "type": "string",
      "x-go-type": {
        "type": "HardwareAddr"
      },
      "x-omitempty": false
    },
    "Name": {
      "example": "container_1",
      "type": "string",
      "x-omitempty": false
    }
  },
  "type": "object"
}