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 Swarm API

Engines can be clustered together in a swarm. Refer to the[swarm mode documentation](https://docs.docker.com/engine/swarm/)for more information.

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

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

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

7 operations 7 paths 7 schemas 2 GET5 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 7 paths, the API surfaces 7 operations — 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Swarm 7

Engines can be clustered together in a swarm. Refer to the [swarm mode documentation](https://docs.docker.com/engine/swarm/) for more information.

GET
/swarm
Inspect swarm
SwarmInspect → 200404500503
POST
/swarm/init
Initialize a new swarm
SwarmInit 1 param → 200400500503
POST
/swarm/join
Join an existing swarm
SwarmJoin 1 param → 200400500503
POST
/swarm/leave
Leave a swarm
SwarmLeave 1 param → 200500503
POST
/swarm/update
Update a swarm
SwarmUpdate 5 params → 200400500503
GET
/swarm/unlockkey
Get the unlock key
SwarmUnlockkey → 200500503
POST
/swarm/unlock
Unlock a locked manager
SwarmUnlock 1 param → 200500503

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ClusterInfo (10 properties), SwarmSpec (8 properties), TLSInfo (3 properties), JoinTokens (2 properties). Each schema is shown below with its type and property counts.

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
JoinTokens
object
JoinTokens contains the tokens workers and managers need to join the swarm.
2 properties
Swarm
object
TLSInfo
object
Information about the issuer of leaf TLS certificates and the trusted root CA certificate.
3 properties
ErrorResponse
object
Represents an error.
1 property 1 required
ClusterInfo
object
ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included.
10 properties
SwarmSpec
object
User modifiable swarm configuration.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

docker-swarm-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 System API
Where this information came from

This is an independent, third-party profile of Docker Swarm 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.