Skip to Content
Next Hat

67 operations · 183 schemas · specification v0.14.0

Download OpenAPI YAML ↗

Nanocl Daemon (v0.14.0)

nanocl contributors: [email protected] License: MIT OR Apache-2.0

The Nanocl Daemon is an HTTP REST API.
It is the API the Nanocl Client uses, so everything the Nanocl Client can do can be done with the API.

Most of the client's commands map directly to API endpoints e.g: nanocl ps is GET /processes.
The notable exception is running Cargo, which consists of several API calls.

OpenAPI Specification

This API is documented in OpenAPI format using Utoipa
The specification is generated automatically when running in development only.
When releasing a version, the generated file is transfered to our Documentation.

Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec.
And that allows cross-domain communication from the browser.
All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Cargoes

List cargoes

query Parameters
filter
string or null
Example: filter={ "where": { "name": { "eq": "test" } } }

Generic filter

namespace
string or null

Namespace where the cargoes are

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new cargo

query Parameters
namespace
string or null

Namespace where the cargo belongs

Request Body schema: application/json
required
required
object (Config)

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object or null

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

object

Metadata of the cargo (user defined)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
required
string

Name of the cargo

(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null))

Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster

Discriminator field: Mode.

One of
Mode
required
string
Value: "Auto"
Secrets
Array of strings or null

List of secrets to use as environment variables

Responses

Request samples

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": {
    },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": "Never",
  • "Container": {
    },
  • "Replication": {
    }
}

Response samples

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

create_exec_command

path Parameters
Name
required
string

Name of the cargo

query Parameters
Namespace
string or null

Namespace of the cargo

Request Body schema: application/json
required
AttachStderr
boolean or null

Attach to stderr of the exec command.

AttachStdin
boolean or null

Attach to stdin of the exec command.

AttachStdout
boolean or null

Attach to stdout of the exec command.

Cmd
Array of strings or null

Command to run, as a string or array of strings.

DetachKeys
string or null

Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.

Env
Array of strings or null

A list of environment variables in the form ["VAR=value", ...].

Privileged
boolean or null

Runs the exec process with extended privileges.

Tty
boolean or null

Allocate a pseudo-TTY.

User
string or null

The user, and optionally, group to run the exec process inside the container. Format is one of: user, user:group, uid, or uid:gid.

WorkingDir
string or null

The working directory for the exec process inside the container.

Responses

Request samples

Content type
application/json
{
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "Tty": true,
  • "DetachKeys": "string",
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Privileged": true,
  • "User": "string",
  • "WorkingDir": "string"
}

Create a new cargo spec and add history entry

path Parameters
name
required
string

Name of the cargo

query Parameters
namespace
string or null

Namespace where the cargo belongs

Request Body schema: application/json
required
required
object (Config)

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object or null

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

object

Metadata of the cargo (user defined)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
required
string

Name of the cargo

(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null))

Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster

Discriminator field: Mode.

One of
Mode
required
string
Value: "Auto"
Secrets
Array of strings or null

List of secrets to use as environment variables

Responses

Request samples

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": {
    },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": "Never",
  • "Container": {
    },
  • "Replication": {
    }
}

Response samples

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

Delete a cargo

path Parameters
name
required
string

Name of the cargo

query Parameters
force
required
boolean

If true forces the delete operation

namespace
string or null

Namespace where the cargo belongs

Responses

Patch a cargo spec meaning merging current spec with the new one and add history entry

path Parameters
name
required
string

Name of the cargo

query Parameters
namespace
string or null

Namespace where the cargo belongs

Request Body schema: application/json
required
object or null

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object or null

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

object

New metadata of the cargo (user defined)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
string or null

New name of the cargo

(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null))

Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster

Discriminator field: Mode.

One of
Mode
required
string
Value: "Auto"
Secrets
Array of strings or null

List of secrets to use as environment variables

Responses

Request samples

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": {
    },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": "Never",
  • "Container": {
    },
  • "Replication": {
    }
}

Response samples

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

List cargo histories

path Parameters
name
required
string

Name of the cargo

query Parameters
namespace
string or null

Namespace where the cargo belongs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Revert a cargo to a specific history

path Parameters
id
required
string

Id of the cargo history

name
required
string

Name of the cargo

query Parameters
namespace
string or null

Namespace where the cargo belongs

Responses

Response samples

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

Get detailed information about a cargo

path Parameters
name
required
string

Name of the cargo

query Parameters
namespace
string or null

Namespace where the cargo belongs

Responses

Response samples

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Status": {
    },
  • "Spec": {
    },
  • "Instances": [
    ]
}

Events

Events management endpoints.

Get events of all peer nodes

query Parameters
filter
string or null
Example: filter={ "where": { "kind": { "eq": "normal" } } }

Generic filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Watch on new events using Server-Sent Events / EventSource

Request Body schema: application/json
optional
Array
required
Array of strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or objects (NativeEventAction)
ActorKey
string or null
ActorKind
string or null
Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind is the type of event related to the actor kind

Kind
required
Array of strings (EventKind)
Items Enum: "error" "normal" "warning"
RelatedKey
string or null
RelatedKind
string or null
Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind is the type of event related to the actor kind

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Exec

Inspect a command executed in a cargo

path Parameters
id
required
string

Exec id to inspect

Responses

Response samples

Content type
application/json
{
  • "CanRemove": true,
  • "DetachKeys": "string",
  • "ID": "string",
  • "Running": true,
  • "ExitCode": 0,
  • "ProcessConfig": {
    },
  • "OpenStdin": true,
  • "OpenStderr": true,
  • "OpenStdout": true,
  • "ContainerID": "string",
  • "Pid": 0
}

start_exec_command

path Parameters
id
required
string

Exec command id

Request Body schema: application/json
required
Detach
required
boolean

Detach from the command.

OutputCapacity
integer or null >= 0

The maximum size for a line of output. The default is 8 * 1024 (roughly 1024 characters).

Tty
required
boolean

Allocate a pseudo-TTY.

Responses

Request samples

Content type
application/json
{
  • "Detach": true,
  • "Tty": true,
  • "OutputCapacity": 0
}

Jobs

Jobs management endpoints.

List jobs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a job

Request Body schema: application/json
required
required
Array of objects (Config)

List of container to run

Array
ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object

Metadata (user defined)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
required
string

Name of the job

Schedule
string or null

Schedule of the job (cron)

Secrets
Array of strings or null

Secrets to load as environment variables

Ttl
integer or null >= 0

Remove the job after (x) seconds after execution

Responses

Request samples

Content type
application/json
{
  • "Name": "string",
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": "Never",
  • "Containers": [
    ]
}

Response samples

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": "Never",
  • "Containers": [
    ]
}

Delete a job

path Parameters
name
required
string

Name of the job

Responses

Inspect a job

path Parameters
name
required
string

Name of the job

Responses

Response samples

Content type
application/json
{
  • "Status": {
    },
  • "InstanceTotal": 0,
  • "InstanceSuccess": 0,
  • "InstanceRunning": 0,
  • "InstanceFailed": 0,
  • "Spec": {
    },
  • "Instances": [
    ]
}

Metrics

Metrics management endpoints.

Get metrics of all peer nodes

query Parameters
filter
string or null
Example: filter={ "where": { "kind": { "eq": "CPU" } } }

Generic filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create_metric

Request Body schema: application/json
required
Data
required
any

The data of the metric

Kind
required
string

The kind of the metric

Note
string or null

Optional note about the metric

Responses

Request samples

Content type
application/json
{
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

Response samples

Content type
application/json
{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ExpiresAt": "2019-08-24T14:15:22Z",
  • "NodeName": "string",
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

Namespaces

Namespaces management endpoints.

List namespaces

query Parameters
filter
string or null
Example: filter={ "where": { "name": { "eq": "test" } } }

Generic filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a namespace

Request Body schema: application/json
required
Name
required
string

Name of the namespace

Responses

Request samples

Content type
application/json
{
  • "Name": "string"
}

Response samples

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z"
}

Delete a namespace

path Parameters
name
required
string

Name of the namespace to delete

Responses

Response samples

Content type
application/json
{
  • "msg": "string"
}

Get detailed information about a namespace

path Parameters
name
required
string

The namespace name to inspect

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Nodes

Nodes management endpoints.

List nodes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Websocket endpoint for communication between nodes used internally

Responses

Processes

Processes management endpoints.

List process (Vm, Job, Cargo)

query Parameters
filter
string or null
Example: filter={ "where": { "name": { "eq": "test" } } }

Generic filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Send a signal to processes of given kind and name

path Parameters
kind
required
string
Example: cargo

Kind of the process

name
required
string
Example: deploy-example

Name of the process

query Parameters
namespace
string or null

Namespace where the process belongs is needed

Request Body schema: application/json
required
signal
required
string

Signal to send to the container default: SIGKILL

Responses

Request samples

Content type
application/json
{
  • "signal": "string"
}

Get logs of processes for all instances of given kind and name (cargo, job, vm)

path Parameters
kind
required
string
Example: cargo

Kind of the process

name
required
string
Example: deploy-example

Name of the process

query Parameters
follow
boolean or null

Boolean to return a stream or not

namespace
string or null

Namespace of the process

since
integer or null <int64>

Only logs returned since timestamp

tail
string or null

Only return the n last (integer) or all ("all") logs

timestamps
boolean or null

Add timestamps to every log line

until
integer or null <int64>

Only logs returned until timestamp

Responses

Restart processes of given kind and name

path Parameters
kind
required
string
Example: cargo

Kind of the process

name
required
string
Example: deploy-example

Name of the process

query Parameters
namespace
string or null

Namespace where the process belongs is needed

Responses

Start processes of given kind and name

path Parameters
kind
required
string
Example: cargo

Kind of the process

name
required
string
Example: deploy-example

Name of the process

query Parameters
namespace
string or null

Namespace where the process belongs is needed

Responses

Get stats of a cargo instance

path Parameters
kind
required
string
Example: cargo

Kind of process

name
required
string
Example: deploy-example

Name of the process group

query Parameters
namespace
string or null

Namespace where the cargo belongs

one_shot
boolean or null

Return stats only once

stream
boolean or null

Return a stream of stats

Responses

Stop a processes of given kind and name

path Parameters
kind
required
string
Example: cargo

Kind of the process

name
required
string
Example: deploy-example

Name of the process

query Parameters
namespace
string or null

Namespace where the process belongs is needed

Responses

Wait for a job to finish

path Parameters
name
required
string

Name of the job instance usually name or name-number

Responses

Get logs of a single process instance by it's name or id

path Parameters
name
required
string
Example: deploy-example

Name of the process

query Parameters
follow
boolean or null

Boolean to return a stream or not

since
integer or null <int64>

Only logs returned since timestamp

tail
string or null

Only return the n last (integer) or all ("all") logs

timestamps
boolean or null

Add timestamps to every log line

until
integer or null <int64>

Only logs returned until timestamp

Responses

ResourceKinds

List resource kinds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a resource kind

Request Body schema: application/json
required
required
object (ResourceKindSpec)

Specification of a resource kind. Depending on the spec it will validate a JSONSchema or call a service.

object

The JSONSchema of the resource of this kind and version

Url
string or null

The service to call when creating, updating or deleting a resource of this kind and version

object

Metadata (user defined) of the resource kind

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
required
string

The name of the resource kind

Version
required
string

The version of the resource kind

Responses

Request samples

Content type
application/json
{
  • "Name": "string",
  • "Version": "string",
  • "Metadata": {
    },
  • "Data": {
    }
}

Response samples

Content type
application/json
{
  • "Name": "string",
  • "Version": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Metadata": null,
  • "Data": {
    }
}

Delete a resource kind

path Parameters
domain
required
string

Domain of the resource kind

name
required
string

Name of the resource kind

Responses

Inspect a resource kind

path Parameters
domain
required
string

Domain of the resource kind

name
required
string

Name of the resource kind

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Versions": [
    ]
}

Inspect a specific version of a resource kind

path Parameters
domain
required
string

Domain of the resource kind

name
required
string

Name of the resource kind

Responses

Response samples

Content type
application/json
{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "KindKey": "string",
  • "Version": "string",
  • "Metadata": {
    },
  • "Data": {
    }
}

Resources

Resources management endpoints.

List resources

query Parameters
filter
string or null
Example: filter={ "where": { "kind": { "eq": "ProxyRule" } } }

Generic filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a resource

Request Body schema: application/json
required
required
object

The data of the resource (json object)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Kind
required
string

The kind of the resource

object

The metadata of the resource (user defined)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
required
string

The name of the resource

Responses

Request samples

Content type
application/json
{
  • "Name": "string",
  • "Kind": "string",
  • "Data": {
    },
  • "Metadata": {
    }
}

Response samples

Content type
application/json
{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

Get detailed information about a resource

path Parameters
name
required
string

The resource name to inspect

Responses

Response samples

Content type
application/json
{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

Create a new resource spec and add history entry

path Parameters
name
required
string

Name of the resource

Request Body schema: application/json
required
required
object

The spec of the resource as a json object

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

object

The metadata of the resource as a json object

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Responses

Request samples

Content type
application/json
{
  • "Data": {
    },
  • "Metadata": {
    }
}

Response samples

Content type
application/json
{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

Delete a resource

path Parameters
name
required
string

The resource name to delete

Responses

Response samples

Content type
application/json
{
  • "msg": "string"
}

List resource history

path Parameters
name
required
string

The resource name to list history

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Revert a resource to a specific history

path Parameters
id
required
string

The resource history id to revert to

name
required
string

The resource name to revert

Responses

Response samples

Content type
application/json
{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

Schemas

Address

Addr
string or null

IP address.

PrefixLen
integer or null <int64>

Mask length of the IP address.

{
  • "Addr": "string",
  • "PrefixLen": 0
}

Any

One of
string

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Example
{
  • "property1": "string",
  • "property2": "string"
}

ApiError

msg
required
string
{
  • "msg": "string"
}

BinaryInfo

Arch
required
string

Arch is the architecture of the current binary

Channel
required
string

Channel is the channel of the current binary

CommitId
required
string

CommitID is the commit id of the current binary

Version
required
string

Version is the version of the current binary

{
  • "Arch": "string",
  • "Channel": "string",
  • "Version": "string",
  • "CommitId": "string"
}

BlkioStats

Array of objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Array of objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Array of objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Array of objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Array of objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Array of objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Array of objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Array of objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
{
  • "io_service_bytes_recursive": [
    ],
  • "io_serviced_recursive": [
    ],
  • "io_queue_recursive": [
    ],
  • "io_service_time_recursive": [
    ],
  • "io_wait_time_recursive": [
    ],
  • "io_merged_recursive": [
    ],
  • "io_time_recursive": [
    ],
  • "sectors_recursive": [
    ]
}

BlkioStatsEntry

major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
{
  • "major": 0,
  • "minor": 0,
  • "op": "string",
  • "value": 0
}

BollardDate

string or null (BollardDate)

BollardDate

"2021-01-01T00:00:00.000000000Z"

CPUStats

required
object (CPUUsage)

CPU usage statistics for the container.

percpu_usage
Array of integers or null <int64> [ items <int64 > >= 0 ]
total_usage
required
integer <int64> >= 0
usage_in_kernelmode
required
integer <int64> >= 0
usage_in_usermode
required
integer <int64> >= 0
online_cpus
integer or null <int64> >= 0
system_cpu_usage
integer or null <int64> >= 0
required
object (ThrottlingData)

CPU throttling statistics.

periods
required
integer <int64> >= 0
throttled_periods
required
integer <int64> >= 0
throttled_time
required
integer <int64> >= 0
{
  • "cpu_usage": {
    },
  • "system_cpu_usage": 0,
  • "online_cpus": 0,
  • "throttling_data": {
    }
}

CPUUsage

percpu_usage
Array of integers or null <int64> [ items <int64 > >= 0 ]
total_usage
required
integer <int64> >= 0
usage_in_kernelmode
required
integer <int64> >= 0
usage_in_usermode
required
integer <int64> >= 0
{
  • "percpu_usage": [
    ],
  • "usage_in_usermode": 0,
  • "total_usage": 0,
  • "usage_in_kernelmode": 0
}

Cargo

CreatedAt
required
string <date-time>

When the cargo was created

NamespaceName
required
string

Name of the namespace

required
object (CargoSpec)

A cargo spec is the specification of a cargo It used to know the state of the cargo It keep tracking of an history when you patch an existing cargo

CargoKey
required
string

The key of the cargo

required
object (Config)

Container to create.

CreatedAt
required
string <date-time>

Creation date of the cargo spec

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object or null

Container to create.

Key
required
string <uuid>

Unique identifier of the cargo spec

object

Metadata of the cargo (user defined)

Name
required
string

Name of the cargo

(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null))

Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster

Discriminator field: Mode.

Secrets
Array of strings or null

List of secrets to use as environment variables

Version
required
string

Version of the spec

required
object (ObjPsStatus)
Actual
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

CargoInspect

CreatedAt
required
string <date-time>

When the cargo was created

InstanceRunning
required
integer >= 0

Number of running instances

required
Array of objects (Process)

List of instances

Array
CreatedAt
required
string <date-time>

The created at date

required
object (ContainerInspectResponse)
Key
required
string

The key of the process

Kind
required
string (ProcessKind)
Enum: "vm" "job" "cargo"

Kind of process (Vm, Job, Cargo)

KindKey
required
string

Key of the related kind

Name
required
string

Name of the process

NodeKey
required
string

Key of the node where the container is running

UpdatedAt
required
string <date-time>

Last time the instance was updated

InstanceTotal
required
integer >= 0

Number of instances

NamespaceName
required
string

Name of the namespace

required
object (CargoSpec)

A cargo spec is the specification of a cargo It used to know the state of the cargo It keep tracking of an history when you patch an existing cargo

CargoKey
required
string

The key of the cargo

required
object (Config)

Container to create.

CreatedAt
required
string <date-time>

Creation date of the cargo spec

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object or null

Container to create.

Key
required
string <uuid>

Unique identifier of the cargo spec

object

Metadata of the cargo (user defined)

Name
required
string

Name of the cargo

(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null))

Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster

Discriminator field: Mode.

Secrets
Array of strings or null

List of secrets to use as environment variables

Version
required
string

Version of the spec

required
object (ObjPsStatus)
Actual
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Status": {
    },
  • "Spec": {
    },
  • "Instances": [
    ]
}

CargoKillOptions

signal
required
string

Signal to send to the container default: SIGKILL

{
  • "signal": "string"
}

CargoSpec

CargoKey
required
string

The key of the cargo

required
object (Config)

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

CreatedAt
required
string <date-time>

Creation date of the cargo spec

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object or null

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

Key
required
string <uuid>

Unique identifier of the cargo spec

object

Metadata of the cargo (user defined)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
required
string

Name of the cargo

(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null))

Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster

Discriminator field: Mode.

One of
Mode
required
string
Value: "Auto"
Secrets
Array of strings or null

List of secrets to use as environment variables

Version
required
string

Version of the spec

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CargoKey": "string",
  • "Version": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": {
    },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": "Never",
  • "Container": {
    },
  • "Replication": {
    }
}

CargoSpecPartial

required
object (Config)

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object or null

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

object

Metadata of the cargo (user defined)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
required
string

Name of the cargo

(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null))

Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster

Discriminator field: Mode.

One of
Mode
required
string
Value: "Auto"
Secrets
Array of strings or null

List of secrets to use as environment variables

{
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": {
    },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": "Never",
  • "Container": {
    },
  • "Replication": {
    }
}

CargoSpecUpdate

object or null

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object or null

Container to create.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

object

New metadata of the cargo (user defined)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
string or null

New name of the cargo

(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null))

Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster

Discriminator field: Mode.

One of
Mode
required
string
Value: "Auto"
Secrets
Array of strings or null

List of secrets to use as environment variables

{
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": {
    },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": "Never",
  • "Container": {
    },
  • "Replication": {
    }
}

CargoSummary

CreatedAt
required
string <date-time>

When the cargo was created

InstanceRunning
required
integer >= 0

Number of running instances

InstanceTotal
required
integer >= 0

Number of instances

NamespaceName
required
string

Name of the namespace

required
object (CargoSpec)

A cargo spec is the specification of a cargo It used to know the state of the cargo It keep tracking of an history when you patch an existing cargo

CargoKey
required
string

The key of the cargo

required
object (Config)

Container to create.

CreatedAt
required
string <date-time>

Creation date of the cargo spec

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object or null

Container to create.

Key
required
string <uuid>

Unique identifier of the cargo spec

object

Metadata of the cargo (user defined)

Name
required
string

Name of the cargo

(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null))

Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster

Discriminator field: Mode.

Secrets
Array of strings or null

List of secrets to use as environment variables

Version
required
string

Version of the spec

{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Spec": {
    }
}

ClusterInfo

CreatedAt
string or null (BollardDate)

BollardDate

DataPathPort
integer or null <int32> >= 0

DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used.

DefaultAddrPool
Array of strings or null

Default Address Pool specifies default subnet pools for global scope networks.

ID
string or null

The ID of the swarm.

RootRotationInProgress
boolean or null

Whether there is currently a root CA rotation in progress for the swarm

object or null

User modifiable swarm configuration.

object or null

CA configuration.

object or null

Dispatcher configuration.

object or null

Parameters related to encryption-at-rest.

object or null

User-defined key/value metadata.

Name
string or null

Name of the swarm.

object or null

Orchestration configuration.

object or null

Raft configuration.

object or null

Defaults for creating tasks in this cluster.

SubnetSize
integer or null <int32> >= 0

SubnetSize specifies the subnet size of the networks created from the default subnet pool.

object or null

Information about the issuer of leaf TLS certificates and the trusted root CA certificate.

CertIssuerPublicKey
string or null

The base64-url-safe-encoded raw public key bytes of the issuer.

CertIssuerSubject
string or null

The base64-url-safe-encoded raw subject bytes of the issuer.

TrustRoot
string or null

The root CA certificate(s) that are used to validate leaf TLS certificates.

UpdatedAt
string or null (BollardDate)

BollardDate

object or null

The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects. This approach ensures safe concurrency and determinism in that the change on the object may not be applied if the version number has changed from the last read. In other words, if two update requests specify the same base version, only one of the requests can succeed. As a result, two separate update requests that happen at the same time will not unintentionally overwrite each other.

Index
integer or null <int64> >= 0
{
  • "ID": "string",
  • "Version": {
    },
  • "CreatedAt": "2021-01-01T00:00:00.000000000Z",
  • "UpdatedAt": "2021-01-01T00:00:00.000000000Z",
  • "Spec": {
    },
  • "TLSInfo": {
    },
  • "RootRotationInProgress": true,
  • "DataPathPort": 0,
  • "DefaultAddrPool": [
    ],
  • "SubnetSize": 0
}

Commit

Expected
string or null

Commit ID of external tool expected by dockerd as set at build time.

ID
string or null

Actual commit ID of external tool.

{
  • "ID": "string",
  • "Expected": "string"
}

Config

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

property name*
additional property
object or null (EmptyObject)

EmptyObject

object or null

A test to perform to check that the container is healthy.

Interval
integer or null <int64>

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

Retries
integer or null <int64>

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

StartInterval
integer or null <int64>

The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

StartPeriod
integer or null <int64>

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.

Test
Array of strings or null

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

Timeout
integer or null <int64>

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

object or null

Container configuration that depends on the host we are running on

object or null

Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started.

AutoRemove
boolean or null

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

Binds
Array of strings or null

A list of volume bindings for this container. Each volume binding is a string in one of these forms: - host-src:container-dest[:options] to bind-mount a host path into the container. Both host-src, and container-dest must be an absolute path. - volume-name:container-dest[:options] to bind-mount a volume managed by a volume driver into the container. container-dest must be an absolute path. options is an optional, comma-delimited list of: - nocopy disables automatic copying of data from the container path to the volume. The nocopy flag only applies to named volumes. - [ro|rw] mounts a volume read-only or read-write, respectively. If omitted or set to rw, volumes are mounted read-write. - [z|Z] applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - z: a shared content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - Z: a private unshared label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - [[r]shared|[r]slave|[r]private] specifies mount propagation behavior. This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to shared. For slave volumes, the mount must be set to either shared or slave.

Array of objects or null (ThrottleDevice)

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

Array of objects or null (ThrottleDevice)

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

Array of objects or null (ThrottleDevice)

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

Array of objects or null (ThrottleDevice)

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

BlkioWeight
integer or null <int32> >= 0

Block IO weight (relative weight).

Array of objects or null (ResourcesBlkioWeightDevice)

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

CapAdd
Array of strings or null

A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'.

CapDrop
Array of strings or null

A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'.

Cgroup
string or null

Cgroup to use for the container.

CgroupnsMode
string or null
Enum: "EMPTY" "private" "host"
CgroupParent
string or null

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.

ConsoleSize
Array of integers or null <int32> [ items <int32 > ]

Initial console size, as an [height, width] array.

ContainerIDFile
string or null

Path to a file where the container ID is written

CpuCount
integer or null <int64>

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.

CpuPercent
integer or null <int64>

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.

CpuPeriod
integer or null <int64>

The length of a CPU period in microseconds.

CpuQuota
integer or null <int64>

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

CpuRealtimePeriod
integer or null <int64>

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

CpuRealtimeRuntime
integer or null <int64>

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

CpusetCpus
string or null

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

CpusetMems
string or null

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

CpuShares
integer or null <int64>

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

DeviceCgroupRules
Array of strings or null

a list of cgroup rules to apply to the container

Array of objects or null (DeviceRequest)

A list of requests for devices to be sent to device drivers.

Array of objects or null (DeviceMapping)

A list of devices to add to the container.

Dns
Array of strings or null

A list of DNS servers for the container to use.

DnsOptions
Array of strings or null

A list of DNS options.

DnsSearch
Array of strings or null

A list of DNS search domains.

ExtraHosts
Array of strings or null

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

GroupAdd
Array of strings or null

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

Init
boolean or null

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.

IOMaximumBandwidth
integer or null <int64>

Maximum IO in bytes per second for the container system drive (Windows only).

IOMaximumIOps
integer or null <int64>

Maximum IOps for the container system drive (Windows only)

IpcMode
string or null

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.

Isolation
string or null
Enum: "EMPTY" "default" "process" "hyperv"
KernelMemoryTCP
integer or null <int64>

Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty.

Links
Array of strings or null

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

object or null

The logging configuration for this container

MaskedPaths
Array of strings or null

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

Memory
integer or null <int64>

Memory limit in bytes.

MemoryReservation
integer or null <int64>

Memory soft limit in bytes.

MemorySwap
integer or null <int64>

Total memory limit (memory + swap). Set as -1 to enable unlimited swap.

MemorySwappiness
integer or null <int64>

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

Array of objects or null (Mount)

Specification for mounts to be added to the container.

NanoCpus
integer or null <int64>

CPU quota in units of 10-9 CPUs.

NetworkMode
string or null

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.

OomKillDisable
boolean or null

Disable OOM Killer for the container.

OomScoreAdj
integer or null <int64>

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

PidMode
string or null

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

PidsLimit
integer or null <int64>

Tune a container's PIDs limit. Set 0 or -1 for unlimited, or null to not change.

object or null (PortMap)

PortMap

Privileged
boolean or null

Gives the container full access to the host.

PublishAllPorts
boolean or null

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.

ReadonlyPaths
Array of strings or null

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

ReadonlyRootfs
boolean or null

Mount the container's root filesystem as read only.

object or null

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.

Runtime
string or null

Runtime to use with this container.

SecurityOpt
Array of strings or null

A list of string values to customize labels for MLS systems, such as SELinux.

ShmSize
integer or null <int64>

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

object or null

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

object or null

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

object or null

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\" }

Array of objects or null (ResourcesUlimits)

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

UsernsMode
string or null

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

UTSMode
string or null

UTS namespace to use for the container.

VolumeDriver
string or null

Driver that this container uses to mount volumes.

VolumesFrom
Array of strings or null

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

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

property name*
additional property
string
MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

object or null

A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

property name*
additional property
object or null (EmptyObject)

EmptyObject

WorkingDir
string or null

The working directory for commands to run in.

{
  • "Hostname": "string",
  • "Domainname": "string",
  • "User": "string",
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "ExposedPorts": {
    },
  • "Tty": true,
  • "OpenStdin": true,
  • "StdinOnce": true,
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Healthcheck": {
    },
  • "ArgsEscaped": true,
  • "Image": "string",
  • "Volumes": {
    },
  • "WorkingDir": "string",
  • "Entrypoint": [
    ],
  • "NetworkDisabled": true,
  • "MacAddress": "string",
  • "OnBuild": [
    ],
  • "Labels": {
    },
  • "StopSignal": "string",
  • "StopTimeout": 0,
  • "Shell": [
    ],
  • "HostConfig": {
    },
  • "NetworkingConfig": {
    }
}

ConfigSpec

Data
string or null

Base64-url-safe-encoded (RFC 4648) config data.

object or null

User-defined key/value metadata.

property name*
additional property
string
Name
string or null

User-defined name of the config.

object or null

Driver represents a driver (network, logging, secrets).

Name
required
string

Name of the driver.

object or null

Key/value map of driver-specific options.

{
  • "Name": "string",
  • "Labels": {
    },
  • "Data": "string",
  • "Templating": {
    }
}

ContainerConfig

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

property name*
additional property
object or null (EmptyObject)

EmptyObject

object or null

A test to perform to check that the container is healthy.

Interval
integer or null <int64>

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

Retries
integer or null <int64>

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

StartInterval
integer or null <int64>

The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

StartPeriod
integer or null <int64>

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.

Test
Array of strings or null

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

Timeout
integer or null <int64>

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

Hostname
string or null

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

Image
string or null

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

object or null

User-defined key/value metadata.

property name*
additional property
string
MacAddress
string or null

MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead.

NetworkDisabled
boolean or null

Disable networking for the container.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

property name*
additional property
object or null (EmptyObject)

EmptyObject

WorkingDir
string or null

The working directory for commands to run in.

{
  • "Hostname": "string",
  • "Domainname": "string",
  • "User": "string",
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "ExposedPorts": {
    },
  • "Tty": true,
  • "OpenStdin": true,
  • "StdinOnce": true,
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Healthcheck": {
    },
  • "ArgsEscaped": true,
  • "Image": "string",
  • "Volumes": {
    },
  • "WorkingDir": "string",
  • "Entrypoint": [
    ],
  • "NetworkDisabled": true,
  • "MacAddress": "string",
  • "OnBuild": [
    ],
  • "Labels": {
    },
  • "StopSignal": "string",
  • "StopTimeout": 0,
  • "Shell": [
    ]
}

ContainerInspectResponse

AppArmorProfile
string or null
Args
Array of strings or null

The arguments to the command being run

object or null

Configuration for a container that is portable between hosts. When used as ContainerConfig field in an image, ContainerConfig is an optional field containing the configuration of the container that was last committed when creating the image. Previous versions of Docker builder used this field to store build cache, and it is not in active use anymore.

ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

Hostname
string or null

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

Image
string or null

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

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead.

NetworkDisabled
boolean or null

Disable networking for the container.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

Created
string or null

The time the container was created

Driver
string or null
ExecIDs
Array of strings or null

IDs of exec instances that are running in the container.

object or null

Information about the storage driver used to store the container's and image's filesystem.

required
object

Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only.

Name
required
string

Name of the storage driver.

object or null

Container configuration that depends on the host we are running on

object or null

Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started.

AutoRemove
boolean or null

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

Binds
Array of strings or null

A list of volume bindings for this container. Each volume binding is a string in one of these forms: - host-src:container-dest[:options] to bind-mount a host path into the container. Both host-src, and container-dest must be an absolute path. - volume-name:container-dest[:options] to bind-mount a volume managed by a volume driver into the container. container-dest must be an absolute path. options is an optional, comma-delimited list of: - nocopy disables automatic copying of data from the container path to the volume. The nocopy flag only applies to named volumes. - [ro|rw] mounts a volume read-only or read-write, respectively. If omitted or set to rw, volumes are mounted read-write. - [z|Z] applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - z: a shared content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - Z: a private unshared label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - [[r]shared|[r]slave|[r]private] specifies mount propagation behavior. This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to shared. For slave volumes, the mount must be set to either shared or slave.

Array of objects or null (ThrottleDevice)

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

Array of objects or null (ThrottleDevice)

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

Array of objects or null (ThrottleDevice)

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

Array of objects or null (ThrottleDevice)

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

BlkioWeight
integer or null <int32> >= 0

Block IO weight (relative weight).

Array of objects or null (ResourcesBlkioWeightDevice)

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

CapAdd
Array of strings or null

A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'.

CapDrop
Array of strings or null

A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'.

Cgroup
string or null

Cgroup to use for the container.

CgroupnsMode
string or null
Enum: "EMPTY" "private" "host"
CgroupParent
string or null

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.

ConsoleSize
Array of integers or null <int32> [ items <int32 > ]

Initial console size, as an [height, width] array.

ContainerIDFile
string or null

Path to a file where the container ID is written

CpuCount
integer or null <int64>

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.

CpuPercent
integer or null <int64>

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.

CpuPeriod
integer or null <int64>

The length of a CPU period in microseconds.

CpuQuota
integer or null <int64>

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

CpuRealtimePeriod
integer or null <int64>

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

CpuRealtimeRuntime
integer or null <int64>

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

CpusetCpus
string or null

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

CpusetMems
string or null

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

CpuShares
integer or null <int64>

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

DeviceCgroupRules
Array of strings or null

a list of cgroup rules to apply to the container

Array of objects or null (DeviceRequest)

A list of requests for devices to be sent to device drivers.

Array of objects or null (DeviceMapping)

A list of devices to add to the container.

Dns
Array of strings or null

A list of DNS servers for the container to use.

DnsOptions
Array of strings or null

A list of DNS options.

DnsSearch
Array of strings or null

A list of DNS search domains.

ExtraHosts
Array of strings or null

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

GroupAdd
Array of strings or null

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

Init
boolean or null

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.

IOMaximumBandwidth
integer or null <int64>

Maximum IO in bytes per second for the container system drive (Windows only).

IOMaximumIOps
integer or null <int64>

Maximum IOps for the container system drive (Windows only)

IpcMode
string or null

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.

Isolation
string or null
Enum: "EMPTY" "default" "process" "hyperv"
KernelMemoryTCP
integer or null <int64>

Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty.

Links
Array of strings or null

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

object or null

The logging configuration for this container

MaskedPaths
Array of strings or null

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

Memory
integer or null <int64>

Memory limit in bytes.

MemoryReservation
integer or null <int64>

Memory soft limit in bytes.

MemorySwap
integer or null <int64>

Total memory limit (memory + swap). Set as -1 to enable unlimited swap.

MemorySwappiness
integer or null <int64>

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

Array of objects or null (Mount)

Specification for mounts to be added to the container.

NanoCpus
integer or null <int64>

CPU quota in units of 10-9 CPUs.

NetworkMode
string or null

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.

OomKillDisable
boolean or null

Disable OOM Killer for the container.

OomScoreAdj
integer or null <int64>

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

PidMode
string or null

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

PidsLimit
integer or null <int64>

Tune a container's PIDs limit. Set 0 or -1 for unlimited, or null to not change.

object or null (PortMap)

PortMap

Privileged
boolean or null

Gives the container full access to the host.

PublishAllPorts
boolean or null

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.

ReadonlyPaths
Array of strings or null

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

ReadonlyRootfs
boolean or null

Mount the container's root filesystem as read only.

object or null

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.

Runtime
string or null

Runtime to use with this container.

SecurityOpt
Array of strings or null

A list of string values to customize labels for MLS systems, such as SELinux.

ShmSize
integer or null <int64>

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

object or null

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

object or null

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

object or null

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\" }

Array of objects or null (ResourcesUlimits)

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

UsernsMode
string or null

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

UTSMode
string or null

UTS namespace to use for the container.

VolumeDriver
string or null

Driver that this container uses to mount volumes.

VolumesFrom
Array of strings or null

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

HostnamePath
string or null
HostsPath
string or null
Id
string or null

The ID of the container

Image
string or null

The container's image ID

LogPath
string or null
MountLabel
string or null
Array of objects or null (MountPoint)
Array
Destination
string or null

Destination is the path relative to the container root (/) where the Source is mounted inside the container.

Driver
string or null

Driver is the volume driver used to create the volume (if it is a volume).

Mode
string or null

Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (\"z\" on Linux, empty on Windows).

Name
string or null

Name is the name reference to the underlying data defined by Source e.g., the volume name.

Propagation
string or null

Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the Linux kernel documentation for details. This field is not used on Windows.

RW
boolean or null

Whether the mount is mounted writable (read-write).

Source
string or null

Source location of the mount. For volumes, this contains the storage location of the volume (within /var/lib/docker/volumes/). For bind-mounts, and npipe, this contains the source (host) part of the bind-mount. For tmpfs mount points, this field is empty.

Type
string or null
Enum: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
Name
string or null
object or null

NetworkSettings exposes the network settings in the API

Bridge
string or null

Name of the default bridge interface when dockerd's --bridge flag is set.

EndpointID
string or null

EndpointID uniquely represents a service endpoint in a Sandbox.


> 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

Gateway
string or null

Gateway address for the default "bridge" network.


> 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

GlobalIPv6Address
string or null

Global IPv6 address for the default "bridge" network.


> 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

GlobalIPv6PrefixLen
integer or null <int64>

Mask length of the global IPv6 address.


> 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

HairpinMode
boolean or null

Indicates if hairpin NAT should be enabled on the virtual interface. Deprecated: This field is never set and will be removed in a future release.

IPAddress
string or null

IPv4 address for the default "bridge" network.


> 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

IPPrefixLen
integer or null <int64>

Mask length of the IPv4 address.


> 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

IPv6Gateway
string or null

IPv6 gateway address for this network.


> 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

LinkLocalIPv6Address
string or null

IPv6 unicast address using the link-local prefix. Deprecated: This field is never set and will be removed in a future release.

LinkLocalIPv6PrefixLen
integer or null <int64>

Prefix length of the IPv6 unicast address. Deprecated: This field is never set and will be removed in a future release.

MacAddress
string or null

MAC address for the container on the default "bridge" network.


> 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

object or null

Information about all networks that the container is connected to.

object or null (PortMap)

PortMap

SandboxID
string or null

SandboxID uniquely represents a container's network stack.

SandboxKey
string or null

SandboxKey is the full path of the netns handle

Array of objects or null (Address)

Deprecated: This field is never set and will be removed in a future release.

Array of objects or null (Address)

Deprecated: This field is never set and will be removed in a future release.

Path
string or null

The path to the command being run

Platform
string or null
ProcessLabel
string or null
ResolvConfPath
string or null
RestartCount
integer or null <int64>
SizeRootFs
integer or null <int64>

The total size of all the files in this container.

SizeRw
integer or null <int64>

The size of files that have been created or changed by this container.

object or null

ContainerState stores container's running state. It's part of ContainerJSONBase and will be returned by the "inspect" command.

Dead
boolean or null
Error
string or null
ExitCode
integer or null <int64>

The last exit code of this container

FinishedAt
string or null

The time when this container last exited.

object or null

Health stores information about the container's healthcheck results.

OOMKilled
boolean or null

Whether a process within this container has been killed because it ran out of memory since the container was last started.

Paused
boolean or null

Whether this container is paused.

Pid
integer or null <int64>

The process ID of this container

Restarting
boolean or null

Whether this container is restarting.

Running
boolean or null

Whether this container is running. Note that a running container can be paused. The Running and Paused booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both Running and Paused. Use the Status field instead to determine if a container's state is "running".

StartedAt
string or null

The time when this container was last started.

Status
string or null
Enum: "EMPTY" "created" "running" "paused" "restarting" "removing" "exited" "dead"
{
  • "Id": "string",
  • "Created": "string",
  • "Path": "string",
  • "Args": [
    ],
  • "State": {
    },
  • "Image": "string",
  • "ResolvConfPath": "string",
  • "HostnamePath": "string",
  • "HostsPath": "string",
  • "LogPath": "string",
  • "Name": "string",
  • "RestartCount": 0,
  • "Driver": "string",
  • "Platform": "string",
  • "MountLabel": "string",
  • "ProcessLabel": "string",
  • "AppArmorProfile": "string",
  • "ExecIDs": [
    ],
  • "HostConfig": {
    },
  • "GraphDriver": {
    },
  • "SizeRw": 0,
  • "SizeRootFs": 0,
  • "Mounts": [
    ],
  • "Config": {
    },
  • "NetworkSettings": {
    }
}

ContainerState

Dead
boolean or null
Error
string or null
ExitCode
integer or null <int64>

The last exit code of this container

FinishedAt
string or null

The time when this container last exited.

object or null

Health stores information about the container's healthcheck results.

FailingStreak
integer or null <int64>

FailingStreak is the number of consecutive failures

Array of objects or null (HealthcheckResult)

Log contains the last few results (oldest first)

Status
string or null
Enum: "EMPTY" "none" "starting" "healthy" "unhealthy"
OOMKilled
boolean or null

Whether a process within this container has been killed because it ran out of memory since the container was last started.

Paused
boolean or null

Whether this container is paused.

Pid
integer or null <int64>

The process ID of this container

Restarting
boolean or null

Whether this container is restarting.

Running
boolean or null

Whether this container is running. Note that a running container can be paused. The Running and Paused booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both Running and Paused. Use the Status field instead to determine if a container's state is "running".

StartedAt
string or null

The time when this container was last started.

Status
string or null
Enum: "EMPTY" "created" "running" "paused" "restarting" "removing" "exited" "dead"
{
  • "Status": "EMPTY",
  • "Running": true,
  • "Paused": true,
  • "Restarting": true,
  • "OOMKilled": true,
  • "Dead": true,
  • "Pid": 0,
  • "ExitCode": 0,
  • "Error": "string",
  • "StartedAt": "string",
  • "FinishedAt": "string",
  • "Health": {
    }
}

ContainerStateStatusEnum

string (ContainerStateStatusEnum)
Enum: "EMPTY" "created" "running" "paused" "restarting" "removing" "exited" "dead"
"EMPTY"

ContainerSummary

Command
string or null

Command to run when starting the container

Created
integer or null <int64>

When the container was created

object or null
NetworkMode
string or null
Id
string or null

The ID of this container

Image
string or null

The name of the image used when creating this container

ImageID
string or null

The ID of the image that this container was created from

object or null

User-defined key/value metadata.

property name*
additional property
string
Array of objects or null (MountPoint)
Array
Destination
string or null

Destination is the path relative to the container root (/) where the Source is mounted inside the container.

Driver
string or null

Driver is the volume driver used to create the volume (if it is a volume).

Mode
string or null

Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (\"z\" on Linux, empty on Windows).

Name
string or null

Name is the name reference to the underlying data defined by Source e.g., the volume name.

Propagation
string or null

Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the Linux kernel documentation for details. This field is not used on Windows.

RW
boolean or null

Whether the mount is mounted writable (read-write).

Source
string or null

Source location of the mount. For volumes, this contains the storage location of the volume (within /var/lib/docker/volumes/). For bind-mounts, and npipe, this contains the source (host) part of the bind-mount. For tmpfs mount points, this field is empty.

Type
string or null
Enum: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
Names
Array of strings or null

The names that this container has been given

object or null

A summary of the container's network settings

object or null
Array of objects or null (Port)

The ports exposed by this container

Array
IP
string or null

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

PrivatePort
required
integer <int32> >= 0

Port on the container

PublicPort
integer or null <int32> >= 0

Port exposed on the host

Type
string or null
Enum: "EMPTY" "tcp" "udp" "sctp"
SizeRootFs
integer or null <int64>

The total size of all the files in this container

SizeRw
integer or null <int64>

The size of files that have been created or changed by this container

State
string or null

The state of this container (e.g. Exited)

Status
string or null

Additional human-readable status of this container (e.g. Exit 0)

{
  • "Id": "string",
  • "Names": [
    ],
  • "Image": "string",
  • "ImageID": "string",
  • "Command": "string",
  • "Created": 0,
  • "Ports": [
    ],
  • "SizeRw": 0,
  • "SizeRootFs": 0,
  • "Labels": {
    },
  • "State": "string",
  • "Status": "string",
  • "HostConfig": {
    },
  • "NetworkSettings": {
    },
  • "Mounts": [
    ]
}

ContainerSummaryHostConfig

NetworkMode
string or null
{
  • "NetworkMode": "string"
}

ContainerSummaryNetworkSettings

object or null
additional property
object (EndpointSettings)

Configuration for a network endpoint.

{
  • "Networks": {
    }
}

CreateExecOptions

AttachStderr
boolean or null

Attach to stderr of the exec command.

AttachStdin
boolean or null

Attach to stdin of the exec command.

AttachStdout
boolean or null

Attach to stdout of the exec command.

Cmd
Array of strings or null

Command to run, as a string or array of strings.

DetachKeys
string or null

Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.

Env
Array of strings or null

A list of environment variables in the form ["VAR=value", ...].

Privileged
boolean or null

Runs the exec process with extended privileges.

Tty
boolean or null

Allocate a pseudo-TTY.

User
string or null

The user, and optionally, group to run the exec process inside the container. Format is one of: user, user:group, uid, or uid:gid.

WorkingDir
string or null

The working directory for the exec process inside the container.

{
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "Tty": true,
  • "DetachKeys": "string",
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Privileged": true,
  • "User": "string",
  • "WorkingDir": "string"
}

DaemonConfig

advertise_addr
required
string

Address to advertise to other nodes

conf_dir
required
string

Config directory

docker_host
string

Docker host to use

gateway
required
string

Host gateway automatically detected to host default gateway if not set

gid
required
integer <int32> >= 0

Group id

hostname
required
string

Hostname to use for the node automatically detected if not set

hosts
required
Array of strings

List of hosts to listen on

nodes
required
Array of strings

List of nodes to join

object or null
Cert
string or null
CertCa
string or null
CertKey
string or null
state_dir
required
string

Path to the state directory

{
  • "hosts": [
    ],
  • "state_dir": "string",
  • "docker_host": "string",
  • "gateway": "string",
  • "hostname": "string",
  • "nodes": [
    ],
  • "advertise_addr": "string",
  • "conf_dir": "string",
  • "gid": 0,
  • "ssl": {
    }
}

DeviceMapping

CgroupPermissions
string or null
PathInContainer
string or null
PathOnHost
string or null
{
  • "PathOnHost": "string",
  • "PathInContainer": "string",
  • "CgroupPermissions": "string"
}

DeviceRequest

Capabilities
Array of strings or null[ items ]

A list of capabilities; an OR list of AND lists of capabilities.

Count
integer or null <int64>
DeviceIDs
Array of strings or null
Driver
string or null
object or null

Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver.

property name*
additional property
string
{
  • "Driver": "string",
  • "Count": 0,
  • "DeviceIDs": [
    ],
  • "Capabilities": [
    ],
  • "Options": {
    }
}

DnsEntry

IpAddress
required
string
Name
required
string
{
  • "Name": "string",
  • "IpAddress": "string"
}

Driver

Name
required
string

Name of the driver.

object or null

Key/value map of driver-specific options.

property name*
additional property
string
{
  • "Name": "string",
  • "Options": {
    }
}

EmptyObject

object or null (EmptyObject)

EmptyObject

{ }

EndpointIpamConfig

IPv4Address
string or null
IPv6Address
string or null
LinkLocalIPs
Array of strings or null
{
  • "IPv4Address": "string",
  • "IPv6Address": "string",
  • "LinkLocalIPs": [
    ]
}

EndpointSettings

Aliases
Array of strings or null
DNSNames
Array of strings or null

List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname. These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending .<network-name>. For instance, if container name is my.ctr and the network is named testnet, DNSNames will contain my.ctr and the FQDN will be my.ctr.testnet.

object or null

DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific.

property name*
additional property
string
EndpointID
string or null

Unique ID for the service endpoint in a Sandbox.

Gateway
string or null

Gateway address for this network.

GlobalIPv6Address
string or null

Global IPv6 address.

GlobalIPv6PrefixLen
integer or null <int64>

Mask length of the global IPv6 address.

IPAddress
string or null

IPv4 address.

object or null

EndpointIPAMConfig represents an endpoint's IPAM configuration.

IPv4Address
string or null
IPv6Address
string or null
LinkLocalIPs
Array of strings or null
IPPrefixLen
integer or null <int64>

Mask length of the IPv4 address.

IPv6Gateway
string or null

IPv6 gateway address.

Links
Array of strings or null
MacAddress
string or null

MAC address for the endpoint on this network. The network driver might ignore this parameter.

NetworkID
string or null

Unique ID of the network.

{
  • "IPAMConfig": {
    },
  • "Links": [
    ],
  • "MacAddress": "string",
  • "Aliases": [
    ],
  • "NetworkID": "string",
  • "EndpointID": "string",
  • "Gateway": "string",
  • "IPAddress": "string",
  • "IPPrefixLen": 0,
  • "IPv6Gateway": "string",
  • "GlobalIPv6Address": "string",
  • "GlobalIPv6PrefixLen": 0,
  • "DriverOpts": {
    },
  • "DNSNames": [
    ]
}

Event

Action
required
string

Action is what action was taken/failed regarding to the regarding actor. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters.

object or null

Actor is the actor that triggered the event

object
Key
string or null
Kind
required
string (EventActorKind)
Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind is the type of event related to the actor kind

CreatedAt
required
string <date-time>

When the event was created.

ExpiresAt
required
string <date-time>

When the event expires.

Key
required
string <uuid>

Unique identifier of this event.

Kind
required
string (EventKind)
Enum: "error" "normal" "warning"

Kind of event (Error, Normal, Warning), new types could be added in the future.

object

Standard metadata.

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Note
string or null

Human-readable description of the status of this operation

Reason
required
string

Reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters.

object or null

Actor is the actor that triggered the event

object
Key
string or null
Kind
required
string (EventActorKind)
Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind is the type of event related to the actor kind

ReportingController
required
string

Reporting Controller is the name of the controller that emitted this Event. e.g. nanocl.io/core. This field cannot be empty for new Events.

ReportingNode
required
string

Reporting Node is the name of the node where the Event was generated.

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ExpiresAt": "2019-08-24T14:15:22Z",
  • "ReportingNode": "string",
  • "ReportingController": "string",
  • "Kind": "error",
  • "Action": "string",
  • "Reason": "string",
  • "Note": "string",
  • "Actor": {
    },
  • "Related": {
    },
  • "Metadata": {
    }
}

EventActor

object
additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Key
string or null
Kind
required
string (EventActorKind)
Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind is the type of event related to the actor kind

{
  • "Key": "string",
  • "Kind": "Namespace",
  • "Attributes": {
    }
}

EventActorKind

string (EventActorKind)
Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind is the type of event related to the actor kind

"Namespace"

EventCondition

required
Array of strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or objects (NativeEventAction)
Array
One of
string
Value: "create"

Action is the action that triggered the event

ActorKey
string or null
ActorKind
string or null
Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind is the type of event related to the actor kind

Kind
required
Array of strings (EventKind)
Items Enum: "error" "normal" "warning"
RelatedKey
string or null
RelatedKind
string or null
Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind is the type of event related to the actor kind

{
  • "ActorKey": "string",
  • "ActorKind": "Namespace",
  • "RelatedKey": "string",
  • "RelatedKind": "Namespace",
  • "Kind": [
    ],
  • "Action": [
    ]
}

EventKind

string (EventKind)
Enum: "error" "normal" "warning"

Kind of event (Error, Normal, Warning), new types could be added in the future.

"error"

ExecInspectResponse

CanRemove
boolean or null
ContainerID
string or null
DetachKeys
string or null
ExitCode
integer or null <int64>
ID
string or null
OpenStderr
boolean or null
OpenStdin
boolean or null
OpenStdout
boolean or null
Pid
integer or null <int64>

The system process ID for the exec process.

object or null
arguments
Array of strings or null
entrypoint
string or null
privileged
boolean or null
tty
boolean or null
user
string or null
Running
boolean or null
{
  • "CanRemove": true,
  • "DetachKeys": "string",
  • "ID": "string",
  • "Running": true,
  • "ExitCode": 0,
  • "ProcessConfig": {
    },
  • "OpenStdin": true,
  • "OpenStderr": true,
  • "OpenStdout": true,
  • "ContainerID": "string",
  • "Pid": 0
}

GenericClause

One of
eq
required
string

Equal

{
  • "has-key": "string"
}

GenericCount

Count
required
integer <int64>

Number of items

{
  • "Count": 0
}

GenericFilter

limit
integer or null >= 0

Limit number of items default (100)

offset
integer or null >= 0

Offset to navigate through items

object or null

Where clause

additional property
object or object or object or object or object or object or object or object or object or object or string or string or object or object (GenericClause)

Generic where clause

{
  • "where": {
    },
  • "limit": 0,
  • "offset": 0
}

GenericResources

object or null
Kind
string or null
Value
integer or null <int64>
object or null
Kind
string or null
Value
string or null
{
  • "NamedResourceSpec": {
    },
  • "DiscreteResourceSpec": {
    }
}

GenericResourcesInnerDiscreteResourceSpec

Kind
string or null
Value
integer or null <int64>
{
  • "Kind": "string",
  • "Value": 0
}

GenericResourcesInnerNamedResourceSpec

Kind
string or null
Value
string or null
{
  • "Kind": "string",
  • "Value": "string"
}

GraphDriverData

required
object

Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only.

property name*
additional property
string
Name
required
string

Name of the storage driver.

{
  • "Name": "string",
  • "Data": {
    }
}

Health

FailingStreak
integer or null <int64>

FailingStreak is the number of consecutive failures

Array of objects or null (HealthcheckResult)

Log contains the last few results (oldest first)

Array
End
string or null (BollardDate)

BollardDate

ExitCode
integer or null <int64>

ExitCode meanings: - 0 healthy - 1 unhealthy - 2 reserved (considered unhealthy) - other values: error running probe

Output
string or null

Output from last check

Start
string or null (BollardDate)

BollardDate

Status
string or null
Enum: "EMPTY" "none" "starting" "healthy" "unhealthy"
{
  • "Status": "EMPTY",
  • "FailingStreak": 0,
  • "Log": [
    ]
}

HealthConfig

Interval
integer or null <int64>

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

Retries
integer or null <int64>

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

StartInterval
integer or null <int64>

The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

StartPeriod
integer or null <int64>

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.

Test
Array of strings or null

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

Timeout
integer or null <int64>

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

{
  • "Test": [
    ],
  • "Interval": 0,
  • "Timeout": 0,
  • "Retries": 0,
  • "StartPeriod": 0,
  • "StartInterval": 0
}

HealthStatusEnum

string (HealthStatusEnum)
Enum: "EMPTY" "none" "starting" "healthy" "unhealthy"
"EMPTY"

HealthcheckResult

End
string or null (BollardDate)

BollardDate

ExitCode
integer or null <int64>

ExitCode meanings: - 0 healthy - 1 unhealthy - 2 reserved (considered unhealthy) - other values: error running probe

Output
string or null

Output from last check

Start
string or null (BollardDate)

BollardDate

{
  • "Start": "2021-01-01T00:00:00.000000000Z",
  • "End": "2021-01-01T00:00:00.000000000Z",
  • "ExitCode": 0,
  • "Output": "string"
}

HostConfig

object or null

Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started.

property name*
additional property
string
AutoRemove
boolean or null

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

Binds
Array of strings or null

A list of volume bindings for this container. Each volume binding is a string in one of these forms: - host-src:container-dest[:options] to bind-mount a host path into the container. Both host-src, and container-dest must be an absolute path. - volume-name:container-dest[:options] to bind-mount a volume managed by a volume driver into the container. container-dest must be an absolute path. options is an optional, comma-delimited list of: - nocopy disables automatic copying of data from the container path to the volume. The nocopy flag only applies to named volumes. - [ro|rw] mounts a volume read-only or read-write, respectively. If omitted or set to rw, volumes are mounted read-write. - [z|Z] applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - z: a shared content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - Z: a private unshared label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - [[r]shared|[r]slave|[r]private] specifies mount propagation behavior. This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to shared. For slave volumes, the mount must be set to either shared or slave.

Array of objects or null (ThrottleDevice)

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

Array
Path
string or null

Device path

Rate
integer or null <int64>

Rate

Array of objects or null (ThrottleDevice)

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

Array
Path
string or null

Device path

Rate
integer or null <int64>

Rate

Array of objects or null (ThrottleDevice)

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

Array
Path
string or null

Device path

Rate
integer or null <int64>

Rate

Array of objects or null (ThrottleDevice)

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

Array
Path
string or null

Device path

Rate
integer or null <int64>

Rate

BlkioWeight
integer or null <int32> >= 0

Block IO weight (relative weight).

Array of objects or null (ResourcesBlkioWeightDevice)

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

Array
Path
string or null
Weight
integer or null >= 0
CapAdd
Array of strings or null

A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'.

CapDrop
Array of strings or null

A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'.

Cgroup
string or null

Cgroup to use for the container.

CgroupnsMode
string or null
Enum: "EMPTY" "private" "host"
CgroupParent
string or null

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.

ConsoleSize
Array of integers or null <int32> [ items <int32 > ]

Initial console size, as an [height, width] array.

ContainerIDFile
string or null

Path to a file where the container ID is written

CpuCount
integer or null <int64>

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.

CpuPercent
integer or null <int64>

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.

CpuPeriod
integer or null <int64>

The length of a CPU period in microseconds.

CpuQuota
integer or null <int64>

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

CpuRealtimePeriod
integer or null <int64>

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

CpuRealtimeRuntime
integer or null <int64>

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

CpusetCpus
string or null

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

CpusetMems
string or null

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

CpuShares
integer or null <int64>

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

DeviceCgroupRules
Array of strings or null

a list of cgroup rules to apply to the container

Array of objects or null (DeviceRequest)

A list of requests for devices to be sent to device drivers.

Array
Capabilities
Array of strings or null[ items ]

A list of capabilities; an OR list of AND lists of capabilities.

Count
integer or null <int64>
DeviceIDs
Array of strings or null
Driver
string or null
object or null

Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver.

Array of objects or null (DeviceMapping)

A list of devices to add to the container.

Array
CgroupPermissions
string or null
PathInContainer
string or null
PathOnHost
string or null
Dns
Array of strings or null

A list of DNS servers for the container to use.

DnsOptions
Array of strings or null

A list of DNS options.

DnsSearch
Array of strings or null

A list of DNS search domains.

ExtraHosts
Array of strings or null

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

GroupAdd
Array of strings or null

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

Init
boolean or null

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.

IOMaximumBandwidth
integer or null <int64>

Maximum IO in bytes per second for the container system drive (Windows only).

IOMaximumIOps
integer or null <int64>

Maximum IOps for the container system drive (Windows only)

IpcMode
string or null

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.

Isolation
string or null
Enum: "EMPTY" "default" "process" "hyperv"
KernelMemoryTCP
integer or null <int64>

Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty.

Links
Array of strings or null

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

object or null

The logging configuration for this container

object or null
Type
string or null
MaskedPaths
Array of strings or null

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

Memory
integer or null <int64>

Memory limit in bytes.

MemoryReservation
integer or null <int64>

Memory soft limit in bytes.

MemorySwap
integer or null <int64>

Total memory limit (memory + swap). Set as -1 to enable unlimited swap.

MemorySwappiness
integer or null <int64>

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

Array of objects or null (Mount)

Specification for mounts to be added to the container.

Array
object or null

Optional configuration for the bind type.

Consistency
string or null

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

ReadOnly
boolean or null

Whether the mount should be read-only.

Source
string or null

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

Target
string or null

Container path.

object or null

Optional configuration for the tmpfs type.

Type
string or null
Enum: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
object or null

Optional configuration for the volume type.

NanoCpus
integer or null <int64>

CPU quota in units of 10-9 CPUs.

NetworkMode
string or null

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.

OomKillDisable
boolean or null

Disable OOM Killer for the container.

OomScoreAdj
integer or null <int64>

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

PidMode
string or null

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

PidsLimit
integer or null <int64>

Tune a container's PIDs limit. Set 0 or -1 for unlimited, or null to not change.

object or null (PortMap)

PortMap

Array of objects
Privileged
boolean or null

Gives the container full access to the host.

PublishAllPorts
boolean or null

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.

ReadonlyPaths
Array of strings or null

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

ReadonlyRootfs
boolean or null

Mount the container's root filesystem as read only.

object or null

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.

MaximumRetryCount
integer or null <int64>

If on-failure is used, the number of times to retry before giving up.

Name
string or null
Enum: "EMPTY" "no" "always" "unless-stopped" "on-failure"
Runtime
string or null

Runtime to use with this container.

SecurityOpt
Array of strings or null

A list of string values to customize labels for MLS systems, such as SELinux.

ShmSize
integer or null <int64>

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

object or null

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

property name*
additional property
string
object or null

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

property name*
additional property
string
object or null

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\" }

property name*
additional property
string
Array of objects or null (ResourcesUlimits)

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

Array
Hard
integer or null <int64>

Hard limit

Name
string or null

Name of ulimit

Soft
integer or null <int64>

Soft limit

UsernsMode
string or null

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

UTSMode
string or null

UTS namespace to use for the container.

VolumeDriver
string or null

Driver that this container uses to mount volumes.

VolumesFrom
Array of strings or null

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

{
  • "CpuShares": 0,
  • "Memory": 0,
  • "CgroupParent": "string",
  • "BlkioWeight": 0,
  • "BlkioWeightDevice": [
    ],
  • "BlkioDeviceReadBps": [
    ],
  • "BlkioDeviceWriteBps": [
    ],
  • "BlkioDeviceReadIOps": [
    ],
  • "BlkioDeviceWriteIOps": [
    ],
  • "CpuPeriod": 0,
  • "CpuQuota": 0,
  • "CpuRealtimePeriod": 0,
  • "CpuRealtimeRuntime": 0,
  • "CpusetCpus": "string",
  • "CpusetMems": "string",
  • "Devices": [
    ],
  • "DeviceCgroupRules": [
    ],
  • "DeviceRequests": [
    ],
  • "KernelMemoryTCP": 0,
  • "MemoryReservation": 0,
  • "MemorySwap": 0,
  • "MemorySwappiness": 0,
  • "NanoCpus": 0,
  • "OomKillDisable": true,
  • "Init": true,
  • "PidsLimit": 0,
  • "Ulimits": [
    ],
  • "CpuCount": 0,
  • "CpuPercent": 0,
  • "IOMaximumIOps": 0,
  • "IOMaximumBandwidth": 0,
  • "Binds": [
    ],
  • "ContainerIDFile": "string",
  • "LogConfig": {
    },
  • "NetworkMode": "string",
  • "PortBindings": {
    },
  • "RestartPolicy": {
    },
  • "AutoRemove": true,
  • "VolumeDriver": "string",
  • "VolumesFrom": [
    ],
  • "Mounts": [
    ],
  • "ConsoleSize": [
    ],
  • "Annotations": {
    },
  • "CapAdd": [
    ],
  • "CapDrop": [
    ],
  • "CgroupnsMode": "EMPTY",
  • "Dns": [
    ],
  • "DnsOptions": [
    ],
  • "DnsSearch": [
    ],
  • "ExtraHosts": [
    ],
  • "GroupAdd": [
    ],
  • "IpcMode": "string",
  • "Cgroup": "string",
  • "Links": [
    ],
  • "OomScoreAdj": 0,
  • "PidMode": "string",
  • "Privileged": true,
  • "PublishAllPorts": true,
  • "ReadonlyRootfs": true,
  • "SecurityOpt": [
    ],
  • "StorageOpt": {
    },
  • "Tmpfs": {
    },
  • "UTSMode": "string",
  • "UsernsMode": "string",
  • "ShmSize": 0,
  • "Sysctls": {
    },
  • "Runtime": "string",
  • "Isolation": "EMPTY",
  • "MaskedPaths": [
    ],
  • "ReadonlyPaths": [
    ]
}

HostConfigCgroupnsModeEnum

string (HostConfigCgroupnsModeEnum)
Enum: "EMPTY" "private" "host"
"EMPTY"

HostConfigIsolationEnum

string (HostConfigIsolationEnum)
Enum: "EMPTY" "default" "process" "hyperv"
"EMPTY"

HostConfigLogConfig

object or null
property name*
additional property
string
Type
string or null
{
  • "Type": "string",
  • "Config": {
    }
}

HostInfo

Architecture
string or null

Hardware architecture of the host, as returned by the Go runtime (GOARCH). A full list of possible values can be found in the Go documentation.

BridgeNfIp6tables
boolean or null

Indicates if bridge-nf-call-ip6tables is available on the host.

BridgeNfIptables
boolean or null

Indicates if bridge-nf-call-iptables is available on the host.

CDISpecDirs
Array of strings or null

List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned.

CgroupDriver
string or null
Enum: "EMPTY" "cgroupfs" "systemd" "none"
CgroupVersion
string or null
Enum: "EMPTY" "1" "2"
required
object (DaemonConfig)

Configuration of the daemon It is used to configure the daemon

advertise_addr
required
string

Address to advertise to other nodes

conf_dir
required
string

Config directory

docker_host
string

Docker host to use

gateway
required
string

Host gateway automatically detected to host default gateway if not set

gid
required
integer <int32> >= 0

Group id

hostname
required
string

Hostname to use for the node automatically detected if not set

hosts
required
Array of strings

List of hosts to listen on

nodes
required
Array of strings

List of nodes to join

object or null
state_dir
required
string

Path to the state directory

object or null

Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as containerd, or runC.

Expected
string or null

Commit ID of external tool expected by dockerd as set at build time.

ID
string or null

Actual commit ID of external tool.

Containers
integer or null <int64>

Total number of containers on the host.

ContainersPaused
integer or null <int64>

Number of containers with status \"paused\".

ContainersRunning
integer or null <int64>

Number of containers with status \"running\".

ContainersStopped
integer or null <int64>

Number of containers with status \"stopped\".

CpuCfsPeriod
boolean or null

Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host.

CpuCfsQuota
boolean or null

Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host.

CPUSet
boolean or null

Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See cpuset(7)

CPUShares
boolean or null

Indicates if CPU Shares limiting is supported by the host.

Debug
boolean or null

Indicates if the daemon is running in debug-mode / with debug-level logging enabled.

Array of objects or null (SystemInfoDefaultAddressPools)

List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base "10.10.0.0/16" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools.

Array
Base
string or null

The network address in CIDR format

Size
integer or null <int64>

The network pool size

DefaultRuntime
string or null

Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time.

DockerRootDir
string or null

Root directory of persistent Docker state. Defaults to /var/lib/docker on Linux, and C:\\ProgramData\\docker on Windows.

Driver
string or null

Name of the storage driver in use.

DriverStatus
Array of strings or null[ items ]

Information specific to the storage driver, provided as "label" / "value" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of docker info on the command line.


> Note: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice.

ExperimentalBuild
boolean or null

Indicates if experimental features are enabled on the daemon.

object or null
object or null
object or null
HostGateway
required
string

HostGateway is the gateway address of the host

HttpProxy
string or null

HTTP-proxy configured for the daemon. This value is obtained from the HTTP_PROXY environment variable. Credentials (user info component) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration.

HttpsProxy
string or null

HTTPS-proxy configured for the daemon. This value is obtained from the HTTPS_PROXY environment variable. Credentials (user info component) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration.

ID
string or null

Unique identifier of the daemon.


> Note: The format of the ID itself is not part of the API, and > should not be considered stable.

Images
integer or null <int64>

Total number of images on the host. Both tagged and untagged (dangling) images are counted.

IndexServerAddress
string or null

Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud.

InitBinary
string or null

Name and, optional, path of the docker-init binary. If the path is omitted, the daemon searches the host's $PATH for the binary and uses the first result.

object or null

Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as containerd, or runC.

Expected
string or null

Commit ID of external tool expected by dockerd as set at build time.

ID
string or null

Actual commit ID of external tool.

IPv4Forwarding
boolean or null

Indicates IPv4 forwarding is enabled.

Isolation
string or null
Enum: "EMPTY" "default" "hyperv" "process"
KernelMemoryTCP
boolean or null

Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding memory.kmem.tcp.limit_in_bytes cgroup.

KernelVersion
string or null

Kernel version of the host. On Linux, this information obtained from uname. On Windows this information is queried from the HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\ registry value, for example "10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)".

Labels
Array of strings or null

User-defined labels (key/value metadata) as set on the daemon.


> Note: When part of a Swarm, nodes can both have daemon labels, > set through the daemon configuration, and node labels, set from a > manager node in the Swarm. Node labels are not included in this > field. Node labels can be retrieved using the /nodes/(id) endpoint > on a manager node in the Swarm.

LiveRestoreEnabled
boolean or null

Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected.

LoggingDriver
string or null

The logging driver to use as a default for new containers.

MemoryLimit
boolean or null

Indicates if the host has memory limit support enabled.

MemTotal
integer or null <int64>

Total amount of physical memory available on the host, in bytes.

Name
string or null

Hostname of the host.

NCPU
integer or null <int64>

The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected.

NEventsListener
integer or null <int64>

Number of event listeners subscribed.

NFd
integer or null <int64>

The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled.

NGoroutines
integer or null <int64>

The number of goroutines that currently exist. This information is only returned if debug-mode is enabled.

NoProxy
string or null

Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the NO_PROXY environment variable. Containers do not automatically inherit this configuration.

OomKillDisable
boolean or null

Indicates if OOM killer disable is supported on the host.

OperatingSystem
string or null

Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS" or "Windows Server 2016 Datacenter"

OSType
string or null

Generic type of the operating system of the host, as returned by the Go runtime (GOOS). Currently returned values are "linux" and "windows". A full list of possible values can be found in the Go documentation.

OSVersion
string or null

Version of the host's operating system


> Note: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice.

PidsLimit
boolean or null

Indicates if the host kernel has PID limit support enabled.

object or null

Available plugins per type.


> Note: Only unmanaged (V1) plugins are included in this list. > V1 plugins are "lazily" loaded, and are not returned in this list > if there is no resource using the plugin.

Authorization
Array of strings or null

Names of available authorization plugins.

Log
Array of strings or null

Names of available logging-drivers, and logging-driver plugins.

Network
Array of strings or null

Names of available network-drivers, and network-driver plugins.

Volume
Array of strings or null

Names of available volume-drivers, and network-driver plugins.

ProductLicense
string or null

Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included.

object or null

RegistryServiceConfig stores daemon registry services configuration.

AllowNondistributableArtifactsCIDRs
Array of strings or null

List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax RFC 4632. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > Warning: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts.

AllowNondistributableArtifactsHostnames
Array of strings or null

List of registry hostnames to which nondistributable artifacts can be pushed, using the format <hostname>[:<port>] or <IP address>[:<port>]. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > Warning: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts.

object or null
InsecureRegistryCIDRs
Array of strings or null

List of IP ranges of insecure registries, using the CIDR syntax (RFC 4632). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (127.0.0.0/8) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under IndexConfigs and have their Secure field set to false. > Warning: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option.

Mirrors
Array of strings or null

List of registry URLs that act as a mirror for the official (docker.io) registry.

object or null

Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as containerd, or runC.

Expected
string or null

Commit ID of external tool expected by dockerd as set at build time.

ID
string or null

Actual commit ID of external tool.

object or null

List of OCI compliant runtimes configured on the daemon. Keys hold the "name" used to reference the runtime. The Docker daemon relies on an OCI compliant runtime (invoked via the containerd daemon) as its interface to the Linux kernel namespaces, cgroups, and SELinux. The default runtime is runc, and automatically configured. Additional runtimes can be configured by the user and will be listed here.

additional property
object (Runtime)

Runtime describes an OCI compliant runtime. The runtime is invoked by the daemon via the containerd daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux.

SecurityOptions
Array of strings or null

List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs.

ServerVersion
string or null

Version string of the daemon.

SwapLimit
boolean or null

Indicates if the host has memory swap limit support enabled.

object or null

Represents generic information about swarm.

object or null

ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included.

ControlAvailable
boolean or null
Error
string or null
LocalNodeState
string or null
Enum: "EMPTY" "inactive" "pending" "active" "error" "locked"

Current local status of this node. Enumeration of values. Since this enum's variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

Managers
integer or null <int64>

Total number of managers in the swarm.

NodeAddr
string or null

IP address at which this node can be reached by other nodes in the swarm.

NodeID
string or null

Unique identifier of for this node in the swarm.

Nodes
integer or null <int64>

Total number of nodes in the swarm.

Array of objects or null (PeerNode)

List of ID's and addresses of other managers in the swarm.

SystemTime
string or null

Current system-time in RFC 3339 format with nano-seconds.

Warnings
Array of strings or null

List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user.

{
  • "ID": "string",
  • "Containers": 0,
  • "ContainersRunning": 0,
  • "ContainersPaused": 0,
  • "ContainersStopped": 0,
  • "Images": 0,
  • "Driver": "string",
  • "DriverStatus": [
    ],
  • "DockerRootDir": "string",
  • "Plugins": {
    },
  • "MemoryLimit": true,
  • "SwapLimit": true,
  • "KernelMemoryTCP": true,
  • "CpuCfsPeriod": true,
  • "CpuCfsQuota": true,
  • "CPUShares": true,
  • "CPUSet": true,
  • "PidsLimit": true,
  • "OomKillDisable": true,
  • "IPv4Forwarding": true,
  • "BridgeNfIptables": true,
  • "BridgeNfIp6tables": true,
  • "Debug": true,
  • "NFd": 0,
  • "NGoroutines": 0,
  • "SystemTime": "string",
  • "LoggingDriver": "string",
  • "CgroupDriver": "EMPTY",
  • "CgroupVersion": "EMPTY",
  • "NEventsListener": 0,
  • "KernelVersion": "string",
  • "OperatingSystem": "string",
  • "OSVersion": "string",
  • "OSType": "string",
  • "Architecture": "string",
  • "NCPU": 0,
  • "MemTotal": 0,
  • "IndexServerAddress": "string",
  • "RegistryConfig": {
    },
  • "GenericResources": {
    },
  • "HttpProxy": "string",
  • "HttpsProxy": "string",
  • "NoProxy": "string",
  • "Name": "string",
  • "Labels": [
    ],
  • "ExperimentalBuild": true,
  • "ServerVersion": "string",
  • "Runtimes": {
    },
  • "DefaultRuntime": "string",
  • "Swarm": {
    },
  • "LiveRestoreEnabled": true,
  • "Isolation": "EMPTY",
  • "InitBinary": "string",
  • "ContainerdCommit": {
    },
  • "RuncCommit": {
    },
  • "InitCommit": {
    },
  • "SecurityOptions": [
    ],
  • "ProductLicense": "string",
  • "DefaultAddressPools": [
    ],
  • "Warnings": [
    ],
  • "CDISpecDirs": [
    ],
  • "HostGateway": "string",
  • "Config": {
    }
}

HttpTarget

Redirect
string or null
Enum: "MovedPermanently" "Permanent" "Temporary"
Url
required
string

Url to target

{
  • "Url": "string",
  • "Redirect": "MovedPermanently"
}

ImagePullPolicy

string (ImagePullPolicy)
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

"Never"

IndexInfo

Mirrors
Array of strings or null

List of mirrors, expressed as URIs.

Name
string or null

Name of the registry, such as "docker.io".

Official
boolean or null

Indicates whether this is an official registry (i.e., Docker Hub / docker.io)

Secure
boolean or null

Indicates if the registry is part of the list of insecure registries. If false, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > Warning: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option.

{
  • "Name": "string",
  • "Mirrors": [
    ],
  • "Secure": true,
  • "Official": true
}

Ipam

Array of objects or null (IpamConfig)

List of IPAM configuration options, specified as a map: {\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>}

Array
object or null
Gateway
string or null
IPRange
string or null
Subnet
string or null
Driver
string or null

Name of the IPAM driver to use.

object or null

Driver-specific options, specified as a map.

property name*
additional property
string
{
  • "Driver": "string",
  • "Config": [
    ],
  • "Options": {
    }
}

IpamConfig

object or null
property name*
additional property
string
Gateway
string or null
IPRange
string or null
Subnet
string or null
{
  • "Subnet": "string",
  • "IPRange": "string",
  • "Gateway": "string",
  • "AuxiliaryAddresses": {
    }
}

Job

required
Array of objects (Config)

Containers to run

Array
ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

CreatedAt
required
string <date-time>

When the job have been created

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object

Metadata (user defined)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
required
string

Name of the job

Schedule
string or null

Schedule of the job (cron)

Secrets
Array of strings or null

Secrets to load as environment variables

required
object (ObjPsStatus)
Actual
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Ttl
integer or null >= 0

Remove the job after (x) seconds after execution

UpdatedAt
required
string <date-time>

When the job have been updated

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": "Never",
  • "Containers": [
    ]
}

JobInspect

InstanceFailed
required
integer >= 0

Number of instance failed

InstanceRunning
required
integer >= 0

Number of instance running

required
Array of objects (Process)

List of instances

Array
CreatedAt
required
string <date-time>

The created at date

required
object (ContainerInspectResponse)
Key
required
string

The key of the process

Kind
required
string (ProcessKind)
Enum: "vm" "job" "cargo"

Kind of process (Vm, Job, Cargo)

KindKey
required
string

Key of the related kind

Name
required
string

Name of the process

NodeKey
required
string

Key of the node where the container is running

UpdatedAt
required
string <date-time>

Last time the instance was updated

InstanceSuccess
required
integer >= 0

Number of instance that succeeded

InstanceTotal
required
integer >= 0

Number of instances

required
object (Job)

A job is a collection of containers to run in sequence as a single unit to act like a command

required
Array of objects (Config)

Containers to run

CreatedAt
required
string <date-time>

When the job have been created

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object

Metadata (user defined)

Name
required
string

Name of the job

Schedule
string or null

Schedule of the job (cron)

Secrets
Array of strings or null

Secrets to load as environment variables

required
object (ObjPsStatus)
Ttl
integer or null >= 0

Remove the job after (x) seconds after execution

UpdatedAt
required
string <date-time>

When the job have been updated

required
object (ObjPsStatus)
Actual
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Enum: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "Status": {
    },
  • "InstanceTotal": 0,
  • "InstanceSuccess": 0,
  • "InstanceRunning": 0,
  • "InstanceFailed": 0,
  • "Spec": {
    },
  • "Instances": [
    ]
}

JobPartial

required
Array of objects (Config)

List of container to run

Array
ArgsEscaped
boolean or null

Command is already escaped (Windows only)

AttachStderr
boolean or null

Whether to attach to stderr.

AttachStdin
boolean or null

Whether to attach to stdin.

AttachStdout
boolean or null

Whether to attach to stdout.

Cmd
Array of strings or null

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

Domainname
string or null

The domain name to use for the container.

Entrypoint
Array of strings or null

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

Env
Array of strings or null

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.

object or null

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

object or null

A test to perform to check that the container is healthy.

object or null

Container configuration that depends on the host we are running on

Hostname
string or null

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

Image
string or null

The name of the image to use when creating the container

object or null

User-defined key/value metadata.

MacAddress
string or null

MAC address of the container.

NetworkDisabled
boolean or null

Disable networking for the container.

object or null

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

OnBuild
Array of strings or null

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

OpenStdin
boolean or null

Open stdin

Shell
Array of strings or null

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

StdinOnce
boolean or null

Close stdin after one attached client disconnects

StopSignal
string or null

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

StopTimeout
integer or null <int64>

Timeout to stop a container in seconds.

Tty
boolean or null

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

User
string or null

The user that commands are run as inside the container.

object or null

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

WorkingDir
string or null

The working directory for commands to run in.

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object

Metadata (user defined)

additional property
string or number or boolean or Array of Any (any) or object (Any)

Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec

Name
required
string

Name of the job

Schedule
string or null

Schedule of the job (cron)

Secrets
Array of strings or null

Secrets to load as environment variables

Ttl
integer or null >= 0

Remove the job after (x) seconds after execution

{
  • "Name": "string",
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": "Never",
  • "Containers": [
    ]
}

JobSummary

InstanceFailed
required
integer >= 0

Number of instance failed

InstanceRunning
required
integer >= 0

Number of instance running

InstanceSuccess
required
integer >= 0

Number of instance that succeeded

InstanceTotal
required
integer >= 0

Number of instances

required
object (Job)

A job is a collection of containers to run in sequence as a single unit to act like a command

required
Array of objects (Config)

Containers to run

CreatedAt
required
string <date-time>

When the job have been created

ImagePullPolicy
string or null
Enum: "Never" "Always" "IfNotPresent"

Policy for pulling images related to process objects (job, cargo, vm)

ImagePullSecret
string or null

Secret to use when pulling the image

object

Metadata (user defined)

Name
required
string

Name of the job

Schedule
string or null

Schedule of the job (cron)

Secrets
Array of strings or null

Secrets to load as environment variables

required
object (ObjPsStatus)
Ttl
integer or null >= 0

Remove the job after (x) seconds after execution

UpdatedAt
required
string <date-time>

When the job have been updated

{
  • "InstanceTotal": 0,
  • "InstanceSuccess": 0,
  • "InstanceRunning": 0,
  • "InstanceFailed": 0,
  • "Spec": {
    }
}

LocalNodeState

string (LocalNodeState)
Enum: "EMPTY" "inactive" "pending" "active" "error" "locked"

Current local status of this node. Enumeration of values. Since this enum's variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

"EMPTY"

LocationTarget

One of
DisableLogging
boolean or null

Disable logging for this target

Key
required
string

The key of the cargo or the vm to target

Path
string or null

The http path to target when using http

Port
required
integer <int32> >= 0

The port of the cargo or the vm to target

Example
{
  • "Key": "string",
  • "Port": 0,
  • "Path": "string",
  • "DisableLogging": true
}

MemoryStats

commit
integer or null <int64> >= 0
commit_peak
integer or null <int64> >= 0
commitbytes
integer or null <int64> >= 0
commitpeakbytes
integer or null <int64> >= 0
failcnt
integer or null <int64> >= 0
limit
integer or null <int64> >= 0
max_usage
integer or null <int64> >= 0
privateworkingset
integer or null <int64> >= 0
(MemoryStatsStatsV1 (object or null)) or (MemoryStatsStatsV2 (object or null))

Granular memory statistics for the container.

One of
active_anon
required
integer <int64> >= 0
active_file
required
integer <int64> >= 0
cache
required
integer <int64> >= 0
dirty
required
integer <int64> >= 0
hierarchical_memory_limit
required
integer <int64> >= 0
hierarchical_memsw_limit
integer or null <int64> >= 0
inactive_anon
required
integer <int64> >= 0
inactive_file
required
integer <int64> >= 0
mapped_file
required
integer <int64> >= 0
pgfault
required
integer <int64> >= 0
pgmajfault
required
integer <int64> >= 0
pgpgin
required
integer <int64> >= 0
pgpgout
required
integer <int64> >= 0
rss
required
integer <int64> >= 0
rss_huge
required
integer <int64> >= 0
shmem
integer or null <int64> >= 0
total_active_anon
required
integer <int64> >= 0
total_active_file
required
integer <int64> >= 0
total_cache
required
integer <int64> >= 0
total_dirty
required
integer <int64> >= 0
total_inactive_anon
required
integer <int64> >= 0
total_inactive_file
required
integer <int64> >= 0
total_mapped_file
required
integer <int64> >= 0
total_pgfault
required
integer <int64> >= 0
total_pgmajfault
required
integer <int64> >= 0
total_pgpgin
required
integer <int64> >= 0
total_pgpgout
required
integer <int64> >= 0
total_rss
required
integer <int64> >= 0
total_rss_huge
required
integer <int64> >= 0
total_shmem
integer or null <int64> >= 0
total_unevictable
required
integer <int64> >= 0
total_writeback
required
integer <int64> >= 0
unevictable
required
integer <int64> >= 0
writeback
required
integer <int64> >= 0
usage
integer or null <int64> >= 0
{
  • "stats": {
    },
  • "max_usage": 0,
  • "usage": 0,
  • "failcnt": 0,
  • "limit": 0,
  • "commit": 0,
  • "commit_peak": 0,
  • "commitbytes": 0,
  • "commitpeakbytes": 0,
  • "privateworkingset": 0
}

MemoryStatsStats

One of
active_anon
required
integer <int64> >= 0
active_file
required
integer <int64> >= 0
cache
required
integer <int64> >= 0
dirty
required
integer <int64> >= 0
hierarchical_memory_limit
required
integer <int64> >= 0
hierarchical_memsw_limit
integer or null <int64> >= 0
inactive_anon
required
integer <int64> >= 0
inactive_file
required
integer <int64> >= 0
mapped_file
required
integer <int64> >= 0
pgfault
required
integer <int64> >= 0
pgmajfault
required
integer <int64> >= 0
pgpgin
required
integer <int64> >= 0
pgpgout
required
integer <int64> >= 0
rss
required
integer <int64> >= 0
rss_huge
required
integer <int64> >= 0
shmem
integer or null <int64> >= 0
total_active_anon
required
integer <int64> >= 0
total_active_file
required
integer <int64> >= 0
total_cache
required
integer <int64> >= 0
total_dirty
required
integer <int64> >= 0
total_inactive_anon
required
integer <int64> >= 0
total_inactive_file
required
integer <int64> >= 0
total_mapped_file
required
integer <int64> >= 0
total_pgfault
required
integer <int64> >= 0
total_pgmajfault
required
integer <int64> >= 0
total_pgpgin
required
integer <int64> >= 0
total_pgpgout
required
integer <int64> >= 0
total_rss
required
integer <int64> >= 0
total_rss_huge
required
integer <int64> >= 0
total_shmem
integer or null <int64> >= 0
total_unevictable
required
integer <int64> >= 0
total_writeback
required
integer <int64> >= 0
unevictable
required
integer <int64> >= 0
writeback
required
integer <int64> >= 0
Example
{
  • "cache": 0,
  • "dirty": 0,
  • "mapped_file": 0,
  • "total_inactive_file": 0,
  • "pgpgout": 0,
  • "rss": 0,
  • "total_mapped_file": 0,
  • "writeback": 0,
  • "unevictable": 0,
  • "pgpgin": 0,
  • "total_unevictable": 0,
  • "pgmajfault": 0,
  • "total_rss": 0,
  • "total_rss_huge": 0,
  • "total_writeback": 0,
  • "total_inactive_anon": 0,
  • "rss_huge": 0,
  • "hierarchical_memory_limit": 0,
  • "total_pgfault": 0,
  • "total_active_file": 0,
  • "active_anon": 0,
  • "total_active_anon": 0,
  • "total_pgpgout": 0,
  • "total_cache": 0,
  • "total_dirty": 0,
  • "inactive_anon": 0,
  • "active_file": 0,
  • "pgfault": 0,
  • "inactive_file": 0,
  • "total_pgmajfault": 0,
  • "total_pgpgin": 0,
  • "hierarchical_memsw_limit": 0,
  • "shmem": 0,
  • "total_shmem": 0
}

MemoryStatsStatsV1

active_anon
required
integer <int64> >= 0
active_file
required
integer <int64> >= 0
cache
required
integer <int64> >= 0
dirty
required
integer <int64> >= 0
hierarchical_memory_limit
required
integer <int64> >= 0
hierarchical_memsw_limit
integer or null <int64> >= 0
inactive_anon
required
integer <int64> >= 0
inactive_file
required
integer <int64> >= 0
mapped_file
required
integer <int64> >= 0
pgfault
required
integer <int64> >= 0
pgmajfault
required
integer <int64> >= 0
pgpgin
required
integer <int64> >= 0
pgpgout
required
integer <int64> >= 0
rss
required
integer <int64> >= 0
rss_huge
required
integer <int64> >= 0
shmem
integer or null <int64> >= 0
total_active_anon
required
integer <int64> >= 0
total_active_file
required
integer <int64> >= 0
total_cache
required
integer <int64> >= 0
total_dirty
required
integer <int64> >= 0
total_inactive_anon
required
integer <int64> >= 0
total_inactive_file
required
integer <int64> >= 0
total_mapped_file
required
integer <int64> >= 0
total_pgfault
required
integer <int64> >= 0
total_pgmajfault
required
integer <int64> >= 0
total_pgpgin
required
integer <int64> >= 0
total_pgpgout
required
integer <int64> >= 0
total_rss
required
integer <int64> >= 0
total_rss_huge
required
integer <int64> >= 0
total_shmem
integer or null <int64> >= 0
total_unevictable
required
integer <int64> >= 0
total_writeback
required
integer <int64> >= 0
unevictable
required
integer <int64> >= 0
writeback
required
integer <int64> >= 0
{
  • "cache": 0,
  • "dirty": 0,
  • "mapped_file": 0,
  • "total_inactive_file": 0,
  • "pgpgout": 0,
  • "rss": 0,
  • "total_mapped_file": 0,
  • "writeback": 0,
  • "unevictable": 0,
  • "pgpgin": 0,
  • "total_unevictable": 0,
  • "pgmajfault": 0,
  • "total_rss": 0,
  • "total_rss_huge": 0,
  • "total_writeback": 0,
  • "total_inactive_anon": 0,
  • "rss_huge": 0,
  • "hierarchical_memory_limit": 0,
  • "total_pgfault": 0,
  • "total_active_file": 0,
  • "active_anon": 0,
  • "total_active_anon": 0,
  • "total_pgpgout": 0,
  • "total_cache": 0,
  • "total_dirty": 0,
  • "inactive_anon": 0,
  • "active_file": 0,
  • "pgfault": 0,
  • "inactive_file": 0,
  • "total_pgmajfault": 0,
  • "total_pgpgin": 0,
  • "hierarchical_memsw_limit": 0,
  • "shmem": 0,
  • "total_shmem": 0
}

MemoryStatsStatsV2

active_anon
required
integer <int64> >= 0
active_file
required
integer <int64> >= 0
anon
required
integer <int64> >= 0
anon_thp
required
integer <int64> >= 0
file
required
integer <int64> >= 0
file_dirty
required
integer <int64> >= 0
file_mapped
required
integer <int64> >= 0
file_writeback
required
integer <int64> >= 0
inactive_anon
required
integer <int64> >= 0
inactive_file
required
integer <int64> >= 0
kernel_stack
required
integer <int64> >= 0
pgactivate
required
integer <int64> >= 0
pgdeactivate
required
integer <int64> >= 0
pgfault
required
integer <int64> >= 0
pglazyfree
required
integer <int64> >= 0
pglazyfreed
required
integer <int64> >= 0
pgmajfault
required
integer <int64> >= 0
pgrefill
required
integer <int64> >= 0
pgscan
required
integer <int64> >= 0
pgsteal
required
integer <int64> >= 0
shmem
required
integer <int64> >= 0
slab
required
integer <int64> >= 0
slab_reclaimable
required
integer <int64> >= 0
slab_unreclaimable
required
integer <int64> >= 0
sock
required
integer <int64> >= 0
thp_collapse_alloc
required
integer <int64> >= 0
thp_fault_alloc
required
integer <int64> >= 0
unevictable
required
integer <int64> >= 0
workingset_activate
required
integer <int64> >= 0
workingset_nodereclaim
required
integer <int64> >= 0
workingset_refault
required
integer <int64> >= 0
{
  • "anon": 0,
  • "file": 0,
  • "kernel_stack": 0,
  • "slab": 0,
  • "sock": 0,
  • "shmem": 0,
  • "file_mapped": 0,
  • "file_dirty": 0,
  • "file_writeback": 0,
  • "anon_thp": 0,
  • "inactive_anon": 0,
  • "active_anon": 0,
  • "inactive_file": 0,
  • "active_file": 0,
  • "unevictable": 0,
  • "slab_reclaimable": 0,
  • "slab_unreclaimable": 0,
  • "pgfault": 0,
  • "pgmajfault": 0,
  • "workingset_refault": 0,
  • "workingset_activate": 0,
  • "workingset_nodereclaim": 0,
  • "pgrefill": 0,
  • "pgscan": 0,
  • "pgsteal": 0,
  • "pgactivate": 0,
  • "pgdeactivate": 0,
  • "pglazyfree": 0,
  • "pglazyfreed": 0,
  • "thp_fault_alloc": 0,
  • "thp_collapse_alloc": 0
}

Metric

CreatedAt
required
string <date-time>

When the metric was created

Data
required
any

The data of the metric

ExpiresAt
required
string <date-time>

When the metric will expire

Key
required
string <uuid>

The key of the metric in the database UUID

Kind
required
string

The kind of the metric

NodeName
required
string

The node where the metric come from

Note
string or null

Optional note about the metric

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ExpiresAt": "2019-08-24T14:15:22Z",
  • "NodeName": "string",
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

MetricPartial

Data
required
any

The data of the metric

Kind
required
string

The kind of the metric

Note
string or null

Optional note about the metric

{
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

Mount

object or null

Optional configuration for the bind type.

CreateMountpoint
boolean or null

Create mount point on host if missing

NonRecursive
boolean or null

Disable recursive bind mount.

Propagation
string or null
Enum: "EMPTY" "private" "rprivate" "shared" "rshared" "slave" "rslave"
ReadOnlyForceRecursive
boolean or null

Raise an error if the mount cannot be made recursively read-only.

ReadOnlyNonRecursive
boolean or null

Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to true in conjunction).

Consistency
string or null

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

ReadOnly
boolean or null

Whether the mount should be read-only.

Source
string or null

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

Target
string or null

Container path.

object or null

Optional configuration for the tmpfs type.

Mode
integer or null <int64>

The permission mode for the tmpfs mount in an integer.

SizeBytes
integer or null <int64>

The size for the tmpfs mount in bytes.

Type
string or null
Enum: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
object or null

Optional configuration for the volume type.

object or null

Map of driver specific options

object or null

User-defined key/value metadata.

NoCopy
boolean or null

Populate volume with data from the target.

{
  • "Target": "string",
  • "Source": "string",
  • "Type": "EMPTY",
  • "ReadOnly": true,
  • "Consistency": "string",
  • "BindOptions": {
    },
  • "VolumeOptions": {
    },
  • "TmpfsOptions": {
    }
}

MountBindOptions

CreateMountpoint
boolean or null

Create mount point on host if missing

NonRecursive
boolean or null

Disable recursive bind mount.

Propagation
string or null
Enum: "EMPTY" "private" "rprivate" "shared" "rshared" "slave" "rslave"
ReadOnlyForceRecursive
boolean or null

Raise an error if the mount cannot be made recursively read-only.

ReadOnlyNonRecursive
boolean or null

Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to true in conjunction).

{
  • "Propagation": "EMPTY",
  • "NonRecursive": true,
  • "CreateMountpoint": true,
  • "ReadOnlyNonRecursive": true,
  • "ReadOnlyForceRecursive": true
}

MountBindOptionsPropagationEnum

string (MountBindOptionsPropagationEnum)
Enum: "EMPTY" "private" "rprivate" "shared" "rshared" "slave" "rslave"
"EMPTY"

MountPoint

Destination
string or null

Destination is the path relative to the container root (/) where the Source is mounted inside the container.

Driver
string or null

Driver is the volume driver used to create the volume (if it is a volume).

Mode
string or null

Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (\"z\" on Linux, empty on Windows).

Name
string or null

Name is the name reference to the underlying data defined by Source e.g., the volume name.

Propagation
string or null

Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the Linux kernel documentation for details. This field is not used on Windows.

RW
boolean or null

Whether the mount is mounted writable (read-write).

Source
string or null

Source location of the mount. For volumes, this contains the storage location of the volume (within /var/lib/docker/volumes/). For bind-mounts, and npipe, this contains the source (host) part of the bind-mount. For tmpfs mount points, this field is empty.

Type
string or null
Enum: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
{
  • "Type": "EMPTY",
  • "Name": "string",
  • "Source": "string",
  • "Destination": "string",
  • "Driver": "string",
  • "Mode": "string",
  • "RW": true,
  • "Propagation": "string"
}

MountPointTypeEnum

string (MountPointTypeEnum)
Enum: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
"EMPTY"

MountTmpfsOptions

Mode
integer or null <int64>

The permission mode for the tmpfs mount in an integer.

SizeBytes
integer or null <int64>

The size for the tmpfs mount in bytes.

{
  • "SizeBytes": 0,
  • "Mode": 0
}

MountTypeEnum

string (MountTypeEnum)
Enum: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
"EMPTY"

MountVolumeOptions

object or null

Map of driver specific options

Name
string or null

Name of the driver to use to create the volume.

object or null

key/value map of driver specific options.

object or null

User-defined key/value metadata.

property name*
additional property
string
NoCopy
boolean or null

Populate volume with data from the target.

{
  • "NoCopy": true,
  • "Labels": {
    },
  • "DriverConfig": {
    }
}

MountVolumeOptionsDriverConfig

Name
string or null

Name of the driver to use to create the volume.

object or null

key/value map of driver specific options.

property name*
additional property
string
{
  • "Name": "string",
  • "Options": {
    }
}

Namespace

CreatedAt
required
string <date-time>

When the namespace was created

Name
required
string

The name as primary key of the namespace

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z"
}

NamespaceInspect

required
Array of objects (CargoInspect)

Number of cargoes

Array
CreatedAt
required
string <date-time>

When the cargo was created

InstanceRunning
required
integer >= 0

Number of running instances

required
Array of objects (Process)

List of instances

InstanceTotal
required
integer >= 0

Number of instances

NamespaceName
required
string

Name of the namespace

required
object (CargoSpec)

A cargo spec is the specification of a cargo It used to know the state of the cargo It keep tracking of an history when you patch an existing cargo

required
object (ObjPsStatus)
Name
required
string

Name of the namespace

required
object (Network)
Attachable
boolean or null
object or null
Created
string or null (BollardDate)

BollardDate

Driver
string or null
EnableIPv6
boolean or null
Id
string or null
Ingress
boolean or null
Internal
boolean or null
object or null
object or null
Name
string or null
object or null
Scope
string or null
{
  • "Name": "string",
  • "Cargoes": [