Search or ask Docker

NetworkSettings

NetworkSettings schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

NetworkSettings exposes the network settings in the API
Networks

Type: object

Information about all networks that the container is connected to.
All schema constraints and annotations
{
  "additionalProperties": {
    "$ref": "#/components/schemas/EndpointSettings"
  },
  "description": "Information about all networks that the container is connected to.\n",
  "type": "object"
}
Ports

Schema: PortMap

SandboxID

Type: string

SandboxID uniquely represents a container's network stack.
All schema constraints and annotations
{
  "description": "SandboxID uniquely represents a container's network stack.",
  "example": "9d12daf2c33f5959c8bf90aa513e4f65b561738661003029ec84830cd503a0c3",
  "type": "string"
}
SandboxKey

Type: string

SandboxKey is the full path of the netns handle
All schema constraints and annotations
{
  "description": "SandboxKey is the full path of the netns handle",
  "example": "/var/run/docker/netns/8ab54b426c38",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "NetworkSettings exposes the network settings in the API",
  "properties": {
    "Networks": {
      "additionalProperties": {
        "$ref": "#/components/schemas/EndpointSettings"
      },
      "description": "Information about all networks that the container is connected to.\n",
      "type": "object"
    },
    "Ports": {
      "$ref": "#/components/schemas/PortMap"
    },
    "SandboxID": {
      "description": "SandboxID uniquely represents a container's network stack.",
      "example": "9d12daf2c33f5959c8bf90aa513e4f65b561738661003029ec84830cd503a0c3",
      "type": "string"
    },
    "SandboxKey": {
      "description": "SandboxKey is the full path of the netns handle",
      "example": "/var/run/docker/netns/8ab54b426c38",
      "type": "string"
    }
  },
  "type": "object"
}