How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Docker System API

The System API from Docker — 6 operation(s) for system.

Docker System API is one of 15 APIs that Docker publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 7 operations across 6 paths, and defines 28 schemas. It is described by OpenAPI 2.0, at version 1.54.

7 operations 6 paths 28 schemas 5 GET1 HEAD1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.54
Resource Areas
1

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 5 GET, 1 HEAD, 1 POST. Each is listed below with its method, path, parameters, and response codes.

System 7
POST
/auth
Check auth configuration
SystemAuth 1 param → 200204401500
GET
/info
Get system information
SystemInfo → 200500
GET
/version
Get version
SystemVersion → 200500
GET
/_ping
Ping
SystemPing → 200500
HEAD
/_ping
Ping
SystemPingHead → 200500
GET
/events
Monitor events
SystemEvents 3 params → 200400500
GET
/system/df
Get data usage information
SystemDataUsage 2 params → 200500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are SystemInfo (62 properties), SystemVersion (12 properties), ClusterInfo (10 properties), SwarmInfo (9 properties). Each schema is shown below with its type and property counts.

PeerNode
object
Represents a peer-node in the swarm
2 properties
IndexInfo
object
IndexInfo contains information about a registry.
4 properties
SystemInfo
object
62 properties
VolumesDiskUsage
object
represents system data usage for volume resources.
5 properties
FirewallInfo
object
Information about the daemon's firewalling configuration. This field is currently only used on Linux, and omitted on other platforms.
2 properties
SwarmSpec
object
User modifiable swarm configuration.
8 properties
PluginsInfo
object
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 t…
4 properties
ContainersDiskUsage
object
represents system data usage information for container resources.
5 properties
LocalNodeState
string
Current local status of this node.
SystemVersion
object
Response of Engine API: GET "/version"
12 properties
AuthResponse
object
An identity token was generated successfully.
2 properties 1 required
NRIInfo
object
Information about the Node Resource Interface (NRI). This field is only present if NRI is enabled.
1 property
TLSInfo
object
Information about the issuer of leaf TLS certificates and the trusted root CA certificate.
3 properties
Commit
object
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.
1 property
AuthConfig
object
3 properties
EventActor
object
Actor describes something that generates events, like a container, network, or a volume.
2 properties
EventMessage
object
EventMessage represents the information an event contains.
6 properties
GenericResources
array
User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1).
DeviceInfo
object
DeviceInfo represents a device that can be used by a container.
2 properties
Runtime
object
Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) runtime. The runtime is invoked by the daemon via the containerd daemon. O…
3 properties
ImagesDiskUsage
object
represents system data usage for image resources.
5 properties
SwarmInfo
object
Represents generic information about swarm.
9 properties
RegistryServiceConfig
object
RegistryServiceConfig stores daemon registry services configuration.
3 properties
ObjectVersion
object
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…
1 property
BuildCacheDiskUsage
object
represents system data usage for build cache resources.
5 properties
ErrorResponse
object
Represents an error.
1 property 1 required
ContainerdInfo
object
Information for connecting to the containerd instance that is used by the daemon. This is included for debugging purposes only.
2 properties
ClusterInfo
object
ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included.
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

docker-system-api-openapi.yml Raw ↑

Other APIs Docker publishes across the network.

Docker Config API
Docker Container API
Docker Distribution API
Docker Exec API
Docker Image API
Docker Network API
Docker Node API
Docker Plugin API
Docker Secret API
Docker Service API
Docker Session API
Docker Swarm API
Where this information came from

This is an independent, third-party profile of Docker System API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.