Docker Container API is one of 15 APIs that Docker publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Container. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.
This API exposes
25 operations
across 23 paths,
and defines 47 schemas.
It is described by OpenAPI 2.0, at version 1.54.
The identity and technical contract details declared by the specification.
NetworkingConfig
object
NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker…
1 property
ContainerPidsStats
object
PidsStats contains Linux-specific stats of a container's process-IDs (PIDs). This type is Linux-specific and omitted for Windows containers.
2 properties
ContainerCPUStats
object
CPU related info of the container
4 properties
ContainerUpdateResponse
object
Response for a successful container-update.
1 property
PortMap
object
PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format / , for example, 80/udp. If…
DriverData
object
Information about the storage driver used to store the container's and image's filesystem.
2 properties
2 required
ChangeType
integer
Kind of change Can be one of: - 0: Modified ("C") - 1: Added ("A") - 2: Deleted ("D")
ContainerCPUUsage
object
All CPU stats aggregated since container inception.
4 properties
HealthConfig
object
A test to perform to check that the container is healthy. Healthcheck commands should be side-effect free.
6 properties
OCIDescriptor
object
A descriptor struct containing digest, media type, and size, as defined in the [OCI Content Descriptors Specification](https://github.com/opencontainers/image-…
8 properties
DeviceRequest
object
A request for devices to be sent to device drivers
5 properties
RestartPolicy
object
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…
2 properties
Resources
object
A container's resources (cgroups config, ulimits, etc)
30 properties
ContainerStorageStats
object
StorageStats is the disk I/O stats for read/write on Windows. This type is Windows-specific and omitted for Linux containers.
4 properties
HealthcheckResult
object
HealthcheckResult stores information about a single run of a healthcheck probe
4 properties
ContainerCreateResponse
object
OK response to ContainerCreate operation
2 properties
2 required
ContainerStatsResponse
object
Statistics sample for a container.
13 properties
HostConfig
Container configuration that depends on the host we are running on
ThrottleDevice
object
2 properties
FilesystemChange
object
Change in the container's filesystem.
2 properties
2 required
ContainerBlkioStats
object
BlkioStats stores all IO service stats for data read and write. This type is Linux-specific and holds many fields that are specific to cgroups v1. On a cgroup…
8 properties
Storage
object
Information about the storage used by the container.
1 property
ContainerState
object
ContainerState stores container's running state. It's part of ContainerJSONBase and will be returned by the "inspect" command.
12 properties
ContainerConfig
object
Configuration for a container that is portable between hosts.
24 properties
OCIPlatform
object
Describes the platform which the image in the manifest runs on, as defined in the [OCI Image Index Specification](https://github.com/opencontainers/image-spec/…
5 properties
ContainerSummary
object
17 properties
ContainerBlkioStatEntry
object
Blkio stats entry. This type is Linux-specific and omitted for Windows containers.
4 properties
ContainerThrottlingData
object
CPU throttling stats of the container. This type is Linux-specific and omitted for Windows containers.
3 properties
ContainerInspectResponse
object
27 properties
EndpointSettings
object
Configuration for a network endpoint.
15 properties
MountType
string
The mount type. Available types: - bind a mount of a file or directory from the host into the container. - cluster a Swarm cluster volume. - image an OCI image…
RootFSStorage
object
Information about the storage used for the container's root filesystem.
1 property
PortSummary
object
Describes a port-mapping between the container and the host.
4 properties
2 required
RootFSStorageSnapshot
object
Information about a snapshot backend of the container's root filesystem.
1 property
PortBinding
object
PortBinding represents a binding between a host IP address and a host port.
2 properties
Health
object
Health stores information about the container's healthcheck results.
3 properties
ContainerWaitResponse
object
OK response to ContainerWait operation
2 properties
1 required
MountPoint
object
MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.
8 properties
NetworkSettings
object
NetworkSettings exposes the network settings in the API
4 properties
ContainerNetworkStats
object
Aggregates the network stats of one container
10 properties
ErrorResponse
object
Represents an error.
1 property
1 required
Mount
object
9 properties
DeviceMapping
object
A device mapping between the host and container
3 properties
EndpointIPAMConfig
object
EndpointIPAMConfig represents an endpoint's IPAM configuration.
3 properties
ContainerWaitExitError
object
container waiting error, if any
1 property
ContainerMemoryStats
object
Aggregates all memory stats since container inception on Linux. Windows returns stats for commit and private working set only.
8 properties
ContainerTopResponse
object
Container "top" response.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Docker publishes across the network.
