Interface ContainerCreateRequest

ContainerCreateRequest

interface ContainerCreateRequest {
    ArgsEscaped?: null | boolean;
    AttachStderr?: boolean;
    AttachStdin?: boolean;
    AttachStdout?: boolean;
    Cmd?: string[];
    Domainname?: string;
    Entrypoint?: string[];
    Env?: string[];
    ExposedPorts?: null | {
        [key: string]: object;
    };
    Healthcheck?: HealthConfig;
    HostConfig?: HostConfig;
    Hostname?: string;
    Image?: string;
    Labels?: {
        [key: string]: string;
    };
    MacAddress?: null | string;
    NetworkDisabled?: null | boolean;
    NetworkingConfig?: NetworkingConfig;
    OnBuild?: null | string[];
    OpenStdin?: boolean;
    Shell?: null | string[];
    StdinOnce?: boolean;
    StopSignal?: null | string;
    StopTimeout?: null | number;
    Tty?: boolean;
    User?: string;
    Volumes?: {
        [key: string]: object;
    };
    WorkingDir?: string;
}

Properties

ArgsEscaped? AttachStderr? AttachStdin? AttachStdout? Cmd? Domainname? Entrypoint? Env? ExposedPorts? Healthcheck? HostConfig? Hostname? Image? Labels? MacAddress? NetworkDisabled? NetworkingConfig? OnBuild? OpenStdin? Shell? StdinOnce? StopSignal? StopTimeout? Tty? User? Volumes? WorkingDir?

Properties

OptionalArgsEscaped

ArgsEscaped?: null | boolean

Command is already escaped (Windows only)

OptionalAttachStderr

AttachStderr?: boolean

Whether to attach to stderr.

OptionalAttachStdin

AttachStdin?: boolean

Whether to attach to stdin.

OptionalAttachStdout

AttachStdout?: boolean

Whether to attach to stdout.

OptionalCmd

Cmd?: string[]

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

OptionalDomainname

Domainname?: string

The domain name to use for the container.

OptionalEntrypoint

Entrypoint?: string[]

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).

OptionalEnv

Env?: string[]

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.

OptionalExposedPorts

ExposedPorts?: null | {
    [key: string]: object;
}

An object mapping ports to an empty object in the form: {\"<port>/<tcp|udp|sctp>\": {}}

OptionalHealthcheck

Healthcheck?: HealthConfig

OptionalHostConfig

HostConfig?: HostConfig

OptionalHostname

Hostname?: string

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

OptionalImage

Image?: string

The name (or reference) of the image to use when creating the container, or which was used when the container was created.

OptionalLabels

Labels?: {
    [key: string]: string;
}

User-defined key/value metadata.

OptionalMacAddress

MacAddress?: null | string

MAC address of the container.

OptionalNetworkDisabled

NetworkDisabled?: null | boolean

Disable networking for the container.

OptionalNetworkingConfig

NetworkingConfig?: NetworkingConfig

OptionalOnBuild

OnBuild?: null | string[]

ONBUILD metadata that were defined in the image's Dockerfile.

OptionalOpenStdin

OpenStdin?: boolean

Open stdin

OptionalShell

Shell?: null | string[]

Shell for when RUN, CMD, and ENTRYPOINT uses a shell.

OptionalStdinOnce

StdinOnce?: boolean

Close stdin after one attached client disconnects

OptionalStopSignal

StopSignal?: null | string

Signal to stop a container as a string or unsigned integer.

OptionalStopTimeout

StopTimeout?: null | number

Timeout to stop a container in seconds.

OptionalTty

Tty?: boolean

Attach standard streams to a TTY, including stdin if it is not closed.

OptionalUser

User?: string

The user that commands are run as inside the container.

OptionalVolumes

Volumes?: {
    [key: string]: object;
}

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

OptionalWorkingDir

WorkingDir?: string

The working directory for commands to run in.

Settings

Member Visibility

On This Page

Properties