# A Swagger 2.0 (a.k.a. OpenAPI) definition of the Engine API.

#

# This is used for generating API documentation and the types used by the

# client/server. See api/README.md for more information.

#

# Some style notes:

# - This file is used by ReDoc, which allows GitHub Flavored Markdown in

# descriptions.

# - There is no maximum line length, for ease of editing and pretty diffs.

# - operationIds are in the format "NounVerb", with a singular noun.

swagger: "2.0"

schemes:

- "http"

- "https"

produces:

- "application/json"

- "text/plain"

consumes:

- "application/json"

- "text/plain"

basePath: "/v1.40"

info:

title: "Docker Engine API"

version: "1.40"

x-logo:

url: "https://docs.docker.com/images/logo-docker-main.png"

description: |

The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API.

Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls.

# Errors

The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:

```

{

"message": "page not found"

}

```

# Versioning

The API is usually changed in each release, so API calls are versioned to

ensure that clients don't break. To lock to a specific version of the API,

you prefix the URL with its version, for example, call `/v1.30/info` to use

the v1.30 version of the `/info` endpoint. If the API version specified in

the URL is not supported by the daemon, a HTTP `400 Bad Request` error message

is returned.

If you omit the version-prefix, the current version of the API (v1.40) is used.

For example, calling `/info` is the same as calling `/v1.40/info`. Using the

API without a version-prefix is deprecated and will be removed in a future release.

Engine releases in the near future should support this version of the API,

so your client will continue to work even if it is talking to a newer Engine.

The API uses an open schema model, which means server may add extra properties

to responses. Likewise, the server will ignore any extra query parameters and

request body properties. When you write clients, you need to ignore additional

properties in responses to ensure they do not break when talking to newer

daemons.

# Authentication

Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a Base64 encoded (JSON) string with the following structure:

```

{

"username": "string",

"password": "string",

"email": "string",

"serveraddress": "string"

}

```

The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required.

If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials:

```

{

"identitytoken": "9cbaf023786cd7..."

}

```

# The tags on paths define the menu sections in the ReDoc documentation, so

# the usage of tags must make sense for that:

# - They should be singular, not plural.

# - There should not be too many tags, or the menu becomes unwieldy. For

# example, it is preferable to add a path to the "System" tag instead of

# creating a tag with a single path in it.

# - The order of tags in this list defines the order in the menu.

tags:

# Primary objects

- name: "Container"

x-displayName: "Containers"

description: |

Create and manage containers.

- name: "Image"

x-displayName: "Images"

- name: "Network"

x-displayName: "Networks"

description: |

Networks are user-defined networks that containers can be attached to. See the [networking documentation](https://docs.docker.com/engine/userguide/networking/) for more information.

- name: "Volume"

x-displayName: "Volumes"

description: |

Create and manage persistent storage that can be attached to containers.

- name: "Exec"

x-displayName: "Exec"

description: |

Run new commands inside running containers. See the [command-line reference](https://docs.docker.com/engine/reference/commandline/exec/) for more information.

To exec a command in a container, you first need to create an exec instance, then start it. These two API endpoints are wrapped up in a single command-line command, `docker exec`.

# Swarm things

- name: "Swarm"

x-displayName: "Swarm"

description: |

Engines can be clustered together in a swarm. See [the swarm mode documentation](https://docs.docker.com/engine/swarm/) for more information.

- name: "Node"

x-displayName: "Nodes"

description: |

Nodes are instances of the Engine participating in a swarm. Swarm mode must be enabled for these endpoints to work.

- name: "Service"

x-displayName: "Services"

description: |

Services are the definitions of tasks to run on a swarm. Swarm mode must be enabled for these endpoints to work.

- name: "Task"

x-displayName: "Tasks"

description: |

A task is a container running on a swarm. It is the atomic scheduling unit of swarm. Swarm mode must be enabled for these endpoints to work.

- name: "Secret"

x-displayName: "Secrets"

description: |

Secrets are sensitive data that can be used by services. Swarm mode must be enabled for these endpoints to work.

- name: "Config"

x-displayName: "Configs"

description: |

Configs are application configurations that can be used by services. Swarm mode must be enabled for these endpoints to work.

# System things

- name: "Plugin"

x-displayName: "Plugins"

- name: "System"

x-displayName: "System"

definitions:

Port:

type: "object"

description: "An open port on a container"

required: [PrivatePort, Type]

properties:

IP:

type: "string"

format: "ip-address"

description: "Host IP address that the container's port is mapped to"

PrivatePort:

type: "integer"

format: "uint16"

x-nullable: false

description: "Port on the container"

PublicPort:

type: "integer"

format: "uint16"

description: "Port exposed on the host"

Type:

type: "string"

x-nullable: false

enum: ["tcp", "udp", "sctp"]

example:

PrivatePort: 8080

PublicPort: 80

Type: "tcp"

MountPoint:

type: "object"

description: "A mount point inside a container"

properties:

Type:

type: "string"

Name:

type: "string"

Source:

type: "string"

Destination:

type: "string"

Driver:

type: "string"

Mode:

type: "string"

RW:

type: "boolean"

Propagation:

type: "string"

DeviceMapping:

type: "object"

description: "A device mapping between the host and container"

properties:

PathOnHost:

type: "string"

PathInContainer:

type: "string"

CgroupPermissions:

type: "string"

example:

PathOnHost: "/dev/deviceName"

PathInContainer: "/dev/deviceName"

CgroupPermissions: "mrw"

ThrottleDevice:

type: "object"

properties:

Path:

description: "Device path"

type: "string"

Rate:

description: "Rate"

type: "integer"

format: "int64"

minimum: 0

Mount:

type: "object"

properties:

Target:

description: "Container path."

type: "string"

Source:

description: "Mount source (e.g. a volume name, a host path)."

type: "string"

Type:

description: |

The mount type. Available types:

- `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container.

- `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed.

- `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.

- `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container.

type: "string"

enum:

- "bind"

- "volume"

- "tmpfs"

- "npipe"

ReadOnly:

description: "Whether the mount should be read-only."

type: "boolean"

Consistency:

description: "The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`."

type: "string"

BindOptions:

description: "Optional configuration for the `bind` type."

type: "object"

properties:

Propagation:

description: "A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`."

type: "string"

enum:

- "private"

- "rprivate"

- "shared"

- "rshared"

- "slave"

- "rslave"

NonRecursive:

description: "Disable recursive bind mount."

type: "boolean"

default: false

VolumeOptions:

description: "Optional configuration for the `volume` type."

type: "object"

properties:

NoCopy:

description: "Populate volume with data from the target."

type: "boolean"

default: false

Labels:

description: "User-defined key/value metadata."

type: "object"

additionalProperties:

type: "string"

DriverConfig:

description: "Map of driver specific options"

type: "object"

properties:

Name:

description: "Name of the driver to use to create the volume."

type: "string"

Options:

description: "key/value map of driver specific options."

type: "object"

additionalProperties:

type: "string"

TmpfsOptions:

description: "Optional configuration for the `tmpfs` type."

type: "object"

properties:

SizeBytes:

description: "The size for the tmpfs mount in bytes."

type: "integer"

format: "int64"

Mode:

description: "The permission mode for the tmpfs mount in an integer."

type: "integer"

RestartPolicy:

description: |

The behavior to apply when the container exits. The default is not to restart.

An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server.

type: "object"

properties:

Name:

type: "string"

description: |

- Empty string means not to restart

- `always` Always restart

- `unless-stopped` Restart always except when the user has manually stopped the container

- `on-failure` Restart only when the container exit code is non-zero

enum:

- ""

- "always"

- "unless-stopped"

- "on-failure"

MaximumRetryCount:

type: "integer"

description: "If `on-failure` is used, the number of times to retry before giving up"

Resources:

description: "A container's resources (cgroups config, ulimits, etc)"

type: "object"

properties:

# Applicable to all platforms

CpuShares:

description: "An integer value representing this container's relative CPU weight versus other containers."

type: "integer"

Memory:

description: "Memory limit in bytes."

type: "integer"

format: "int64"

default: 0

# Applicable to UNIX platforms

CgroupParent:

description: "Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist."

type: "string"

BlkioWeight:

description: "Block IO weight (relative weight)."

type: "integer"

minimum: 0

maximum: 1000

BlkioWeightDevice:

description: |

Block IO weight (relative device weight) in the form `[{"Path": "device_path", "Weight": weight}]`.

type: "array"

items:

type: "object"

properties:

Path:

type: "string"

Weight:

type: "integer"

minimum: 0

BlkioDeviceReadBps:

description: |

Limit read rate (bytes per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

type: "array"

items:

$ref: "#/definitions/ThrottleDevice"

BlkioDeviceWriteBps:

description: |

Limit write rate (bytes per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

type: "array"

items:

$ref: "#/definitions/ThrottleDevice"

BlkioDeviceReadIOps:

description: |

Limit read rate (IO per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

type: "array"

items:

$ref: "#/definitions/ThrottleDevice"

BlkioDeviceWriteIOps:

description: |

Limit write rate (IO per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

type: "array"

items:

$ref: "#/definitions/ThrottleDevice"

CpuPeriod:

description: "The length of a CPU period in microseconds."

type: "integer"

format: "int64"

CpuQuota:

description: "Microseconds of CPU time that the container can get in a CPU period."

type: "integer"

format: "int64"

CpuRealtimePeriod:

description: "The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks."

type: "integer"

format: "int64"

CpuRealtimeRuntime:

description: "The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks."

type: "integer"

format: "int64"

CpusetCpus:

description: "CPUs in which to allow execution (e.g., `0-3`, `0,1`)"

type: "string"

example: "0-3"

CpusetMems:

description: "Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems."

type: "string"

Devices:

description: "A list of devices to add to the container."

type: "array"

items:

$ref: "#/definitions/DeviceMapping"

DeviceCgroupRules:

description: "a list of cgroup rules to apply to the container"

type: "array"

items:

type: "string"

example: "c 13:* rwm"

DiskQuota:

description: "Disk limit (in bytes)."

type: "integer"

format: "int64"

KernelMemory:

description: "Kernel memory limit in bytes."

type: "integer"

format: "int64"

example: 209715200

KernelMemoryTCP:

description: "Hard limit for kernel TCP buffer memory (in bytes)."

type: "integer"

format: "int64"

MemoryReservation:

description: "Memory soft limit in bytes."

type: "integer"

format: "int64"

MemorySwap:

description: "Total memory limit (memory + swap). Set as `-1` to enable unlimited swap."

type: "integer"

format: "int64"

MemorySwappiness:

description: "Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100."

type: "integer"

format: "int64"

minimum: 0

maximum: 100

NanoCPUs:

description: "CPU quota in units of 10^-9 CPUs."

type: "integer"

format: "int64"

OomKillDisable:

description: "Disable OOM Killer for the container."

type: "boolean"

Init:

description: "Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used."

type: "boolean"

x-nullable: true

PidsLimit:

description: "Tune a container's pids limit. Set -1 for unlimited."

type: "integer"

format: "int64"

Ulimits:

description: |

A list of resource limits to set in the container. For example: `{"Name": "nofile", "Soft": 1024, "Hard": 2048}`"

type: "array"

items:

type: "object"

properties:

Name:

description: "Name of ulimit"

type: "string"

Soft:

description: "Soft limit"

type: "integer"

Hard:

description: "Hard limit"

type: "integer"

# Applicable to Windows

CpuCount:

description: |

The number of usable CPUs (Windows only).

On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last.

type: "integer"

format: "int64"

CpuPercent:

description: |

The usable percentage of the available CPUs (Windows only).

On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last.

type: "integer"

format: "int64"

IOMaximumIOps:

description: "Maximum IOps for the container system drive (Windows only)"

type: "integer"

format: "int64"

IOMaximumBandwidth:

description: "Maximum IO in bytes per second for the container system drive (Windows only)"

type: "integer"

format: "int64"

ResourceObject:

description: "An object describing the resources which can be advertised by a node and requested by a task"

type: "object"

properties:

NanoCPUs:

type: "integer"

format: "int64"

example: 4000000000

MemoryBytes:

type: "integer"

format: "int64"

example: 8272408576

GenericResources:

$ref: "#/definitions/GenericResources"

GenericResources:

description: "User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`)"

type: "array"

items:

type: "object"

properties:

NamedResourceSpec:

type: "object"

properties:

Kind:

type: "string"

Value:

type: "string"

DiscreteResourceSpec:

type: "object"

properties:

Kind:

type: "string"

Value:

type: "integer"

format: "int64"

example:

- DiscreteResourceSpec:

Kind: "SSD"

Value: 3

- NamedResourceSpec:

Kind: "GPU"

Value: "UUID1"

- NamedResourceSpec:

Kind: "GPU"

Value: "UUID2"

HealthConfig:

description: "A test to perform to check that the container is healthy."

type: "object"

properties:

Test:

description: |

The test to perform. Possible values are:

- `[]` inherit healthcheck from image or parent image

- `["NONE"]` disable healthcheck

- `["CMD", args...]` exec arguments directly

- `["CMD-SHELL", command]` run command with system's default shell

type: "array"

items:

type: "string"

Interval:

description: "The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit."

type: "integer"

Timeout:

description: "The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit."

type: "integer"

Retries:

description: "The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit."

type: "integer"

StartPeriod:

description: "Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit."

type: "integer"

HostConfig:

description: "Container configuration that depends on the host we are running on"

allOf:

- $ref: "#/definitions/Resources"

- type: "object"

properties:

# Applicable to all platforms

Binds:

type: "array"

description: |

A list of volume bindings for this container. Each volume binding is a string in one of these forms:

- `host-src:container-dest` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path.

- `host-src:container-dest:ro` to make the bind mount read-only inside the container. Both `host-src`, and `container-dest` must be an _absolute_ path.

- `volume-name:container-dest` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path.

- `volume-name:container-dest:ro` to mount the volume read-only inside the container. `container-dest` must be an _absolute_ path.

items:

type: "string"

ContainerIDFile:

type: "string"

description: "Path to a file where the container ID is written"

LogConfig:

type: "object"

description: "The logging configuration for this container"

properties:

Type:

type: "string"

enum:

- "json-file"

- "syslog"

- "journald"

- "gelf"

- "fluentd"

- "awslogs"

- "splunk"

- "etwlogs"

- "none"

Config:

type: "object"

additionalProperties:

type: "string"

NetworkMode:

type: "string"

description: "Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken

as a custom network's name to which this container should connect to."

PortBindings:

$ref: "#/definitions/PortMap"

RestartPolicy:

$ref: "#/definitions/RestartPolicy"

AutoRemove:

type: "boolean"

description: "Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set."

VolumeDriver:

type: "string"

description: "Driver that this container uses to mount volumes."

VolumesFrom:

type: "array"

description: "A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`."

items:

type: "string"

Mounts:

description: "Specification for mounts to be added to the container."

type: "array"

items:

$ref: "#/definitions/Mount"

# Applicable to UNIX platforms

CapAdd:

type: "array"

description: "A list of kernel capabilities to add to the container."

items:

type: "string"

CapDrop:

type: "array"

description: "A list of kernel capabilities to drop from the container."

items:

type: "string"

Dns:

type: "array"

description: "A list of DNS servers for the container to use."

items:

type: "string"

DnsOptions:

type: "array"

description: "A list of DNS options."

items:

type: "string"

DnsSearch:

type: "array"

description: "A list of DNS search domains."

items:

type: "string"

ExtraHosts:

type: "array"

description: |

A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `["hostname:IP"]`.

items:

type: "string"

GroupAdd:

type: "array"

description: "A list of additional groups that the container process will run as."

items:

type: "string"

IpcMode:

type: "string"

description: |

IPC sharing mode for the container. Possible values are:

- `"none"`: own private IPC namespace, with /dev/shm not mounted

- `"private"`: own private IPC namespace

- `"shareable"`: own private IPC namespace, with a possibility to share it with other containers

- `"container:<name|id>"`: join another (shareable) container's IPC namespace

- `"host"`: use the host system's IPC namespace

If not specified, daemon default is used, which can either be `"private"`

or `"shareable"`, depending on daemon version and configuration.

Cgroup:

type: "string"

description: "Cgroup to use for the container."

Links:

type: "array"

description: "A list of links for the container in the form `container_name:alias`."

items:

type: "string"

OomScoreAdj:

type: "integer"

description: "An integer value containing the score given to the container in order to tune OOM killer preferences."

example: 500

PidMode:

type: "string"

description: |

Set the PID (Process) Namespace mode for the container. It can be either:

- `"container:<name|id>"`: joins another container's PID namespace

- `"host"`: use the host's PID namespace inside the container

Privileged:

type: "boolean"

description: "Gives the container full access to the host."

PublishAllPorts:

type: "boolean"

description: |

Allocates an ephemeral host port for all of a container's

exposed ports.

Ports are de-allocated when the container stops and allocated when the container starts.

The allocated port might be changed when restarting the container.

The port is selected from the ephemeral port range that depends on the kernel.

For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`.

ReadonlyRootfs:

type: "boolean"

description: "Mount the container's root filesystem as read only."

SecurityOpt:

type: "array"

description: "A list of string values to customize labels for MLS

systems, such as SELinux."

items:

type: "string"

StorageOpt:

type: "object"

description: |

Storage driver options for this container, in the form `{"size": "120G"}`.

additionalProperties:

type: "string"

Tmpfs:

type: "object"

description: |

A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: `{ "/run": "rw,noexec,nosuid,size=65536k" }`.

additionalProperties:

type: "string"

UTSMode:

type: "string"

description: "UTS namespace to use for the container."

UsernsMode:

type: "string"

description: "Sets the usernamespace mode for the container when usernamespace remapping option is enabled."

ShmSize:

type: "integer"

description: "Size of `/dev/shm` in bytes. If omitted, the system uses 64MB."

minimum: 0

Sysctls:

type: "object"

description: |

A list of kernel parameters (sysctls) to set in the container. For example: `{"net.ipv4.ip_forward": "1"}`

additionalProperties:

type: "string"

Runtime:

type: "string"

description: "Runtime to use with this container."

# Applicable to Windows

ConsoleSize:

type: "array"

description: "Initial console size, as an `[height, width]` array. (Windows only)"

minItems: 2

maxItems: 2

items:

type: "integer"

minimum: 0

Isolation:

type: "string"

description: "Isolation technology of the container. (Windows only)"

enum:

- "default"

- "process"

- "hyperv"

MaskedPaths:

type: "array"

description: "The list of paths to be masked inside the container (this overrides the default set of paths)"

items:

type: "string"

ReadonlyPaths:

type: "array"

description: "The list of paths to be set as read-only inside the container (this overrides the default set of paths)"

items:

type: "string"

ContainerConfig:

description: "Configuration for a container that is portable between hosts"

type: "object"

properties:

Hostname:

description: "The hostname to use for the container, as a valid RFC 1123 hostname."

type: "string"

Domainname:

description: "The domain name to use for the container."

type: "string"

User:

description: "The user that commands are run as inside the container."

type: "string"

AttachStdin:

description: "Whether to attach to `stdin`."

type: "boolean"

default: false

AttachStdout:

description: "Whether to attach to `stdout`."

type: "boolean"

default: true

AttachStderr:

description: "Whether to attach to `stderr`."

type: "boolean"

default: true

ExposedPorts:

description: |

An object mapping ports to an empty object in the form:

`{"<port>/<tcp|udp|sctp>": {}}`

type: "object"

additionalProperties:

type: "object"

enum:

- {}

default: {}

Tty:

description: "Attach standard streams to a TTY, including `stdin` if it is not closed."

type: "boolean"

default: false

OpenStdin:

description: "Open `stdin`"

type: "boolean"

default: false

StdinOnce:

description: "Close `stdin` after one attached client disconnects"

type: "boolean"

default: false

Env:

description: |

A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value.

type: "array"

items:

type: "string"

Cmd:

description: "Command to run specified as a string or an array of strings."

type: "array"

items:

type: "string"

Healthcheck:

$ref: "#/definitions/HealthConfig"

ArgsEscaped:

description: "Command is already escaped (Windows only)"

type: "boolean"

Image:

description: "The name of the image to use when creating the container"

type: "string"

Volumes:

description: "An object mapping mount point paths inside the container to empty objects."

type: "object"

additionalProperties:

type: "object"

enum:

- {}

default: {}

WorkingDir:

description: "The working directory for commands to run in."

type: "string"

Entrypoint:

description: |

The entry point for the container as a string or an array of strings.

If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).

type: "array"

items:

type: "string"

NetworkDisabled:

description: "Disable networking for the container."

type: "boolean"

MacAddress:

description: "MAC address of the container."

type: "string"

OnBuild:

description: "`ONBUILD` metadata that were defined in the image's `Dockerfile`."

type: "array"

items:

type: "string"

Labels:

description: "User-defined key/value metadata."

type: "object"

additionalProperties:

type: "string"

StopSignal:

description: "Signal to stop a container as a string or unsigned integer."

type: "string"

default: "SIGTERM"

StopTimeout:

description: "Timeout to stop a container in seconds."

type: "integer"

default: 10

Shell:

description: "Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell."

type: "array"

items:

type: "string"

NetworkSettings:

description: "NetworkSettings exposes the network settings in the API"

type: "object"

properties:

Bridge:

description: Name of the network'a bridge (for example, `docker0`).

type: "string"

example: "docker0"

SandboxID:

description: SandboxID uniquely represents a container's network stack.

type: "string"

example: "9d12daf2c33f5959c8bf90aa513e4f65b561738661003029ec84830cd503a0c3"

HairpinMode:

description: |

Indicates if hairpin NAT should be enabled on the virtual interface.

type: "boolean"

example: false

LinkLocalIPv6Address:

description: IPv6 unicast address using the link-local prefix.

type: "string"

example: "fe80::42:acff:fe11:1"

LinkLocalIPv6PrefixLen:

description: Prefix length of the IPv6 unicast address.

type: "integer"

example: "64"

Ports:

$ref: "#/definitions/PortMap"

SandboxKey:

description: SandboxKey identifies the sandbox

type: "string"

example: "/var/run/docker/netns/8ab54b426c38"

# TODO is SecondaryIPAddresses actually used?

SecondaryIPAddresses:

description: ""

type: "array"

items:

$ref: "#/definitions/Address"

x-nullable: true

# TODO is SecondaryIPv6Addresses actually used?

SecondaryIPv6Addresses:

description: ""

type: "array"

items:

$ref: "#/definitions/Address"

x-nullable: true

# TODO properties below are part of DefaultNetworkSettings, which is

# marked as deprecated since Docker 1.9 and to be removed in Docker v17.12

EndpointID:

description: |

EndpointID uniquely represents a service endpoint in a Sandbox.

<p><br /></p>

> **Deprecated**: This field is only propagated when attached to the

> default "bridge" network. Use the information from the "bridge"

> network inside the `Networks` map instead, which contains the same

> information. This field was deprecated in Docker 1.9 and is scheduled

> to be removed in Docker 17.12.0

type: "string"

example: "b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b"

Gateway:

description: |

Gateway address for the default "bridge" network.

<p><br /></p>

> **Deprecated**: This field is only propagated when attached to the

> default "bridge" network. Use the information from the "bridge"

> network inside the `Networks` map instead, which contains the same

> information. This field was deprecated in Docker 1.9 and is scheduled

> to be removed in Docker 17.12.0

type: "string"

example: "172.17.0.1"

GlobalIPv6Address:

description: |

Global IPv6 address for the default "bridge" network.

<p><br /></p>

> **Deprecated**: This field is only propagated when attached to the

> default "bridge" network. Use the information from the "bridge"

> network inside the `Networks` map instead, which contains the same

> information. This field was deprecated in Docker 1.9 and is scheduled

> to be removed in Docker 17.12.0

type: "string"