Typedefs

ResponsePreprocessor(String s) → String

Properties

containerNameRegex → dynamic

read-only

Enums

ChangeKind

The available change kinds for the changes request.

RestartPolicyVariant

Classes

ApiVersion

Enum of API versions currently considered for API differences.

AuthConfig

Passed as X-Registry-Auth header in requests that need authentication to a registry. Since API version 1.2, the auth configuration is now handled client side, so the client has to send the authConfig as a POST in /images/(name)/push. authConfig, set as the X-Registry-Auth header, is currently a Base64 encoded (JSON) string with the following structure: {"username": "string", "password": "string", "email": "string", "serveraddress" : "string", "auth": ""}. Notice that auth is to be left empty, serveraddress is a domain/ip without protocol, and that double quotes (instead of single ones) are required.

AuthRequest

Argument for the auth request.

AuthResponse

The response to an auth request.

BlkIoStats

ChangesResponse

The argument for the changes request.

CommitRequest

Commit request

CommitResponse

Response to a commit request.

Config

ConfigFile

Container

Basic info about a container.

ContainerEvent

Container related Docker events

ContainerInfo

ContainerStatus

The possible running states of a container.

CopyRequestPath

To create proper JSON for a requested path for a copy request.

CreateContainerRequest

The configuration for the create request.

CreateImageResponse

An item of an image create response

CreateResponse

The response to a create request.

DeMux

DockerConnection

DockerEvent

All Docker events in one enum

DockerEventBase

Base class for all kinds of Docker events

DockerRemoteApiError

Error thrown

EventsFilter

The filter argument to the events request.

EventsResponse

An item of the response to the events request.

Exec

The response to the exec command

ExecInfo

The response to the inspectExec command

HostConfig

HostConfigRequest

The CreateRequest.hostConfig part of the create request configuration.

HostPort

Image

A reference to an image.

ImageEvent

Image related Docker events

ImageHistoryResponse

The response to an images/(name)/history request.

ImageInfo

Information about an image returned by 'inspect'

ImagePushResponse

An item of the response to images/(name)/push.

ImageRemoveResponse

An item of the response to removeImage.

InfoResponse

Response to the info request.

NetworkMode

NetworkSettings

PortArgument

PortBinding

PortResponse

ProcessConfig

RegistryConfigs

RequestType

RestartPolicy

The behavior to apply when the container exits. The value is an object with a Name property of either "always" to always restart or "on-failure" to restart only when the container exit code is non-zero. If on-failure is used, MaximumRetryCount controls the number of times to retry before giving up. The default is not to restart. (optional) An ever increasing delay (double the previous delay, starting at 100mS) is added before each restart to prevent flooding the server.

SearchResponse

An item of the response to search.

ServerReference

SimpleResponse

A response which isn't supposed to carry any information.

State

StatsResponse

The response to a logs request.

StatsResponseCpuStats

StatsResponseCpuUsage

StatsResponseMemoryStats

StatsResponseMemoryStatsStats

StatsResponseNetwork

ThrottlingData

TopResponse

Response to the top request.

Version

VersionResponse

Response to the version request.

Volumes

VolumesRw

WaitResponse

The response to a wait request.