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

Services are the definitions of tasks to run on a swarm. Swarm mode mustbe enabled for these endpoints to work.

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

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

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

6 operations 5 paths 18 schemas 1 DELETE3 GET2 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 6

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

Service 6

Services are the definitions of tasks to run on a swarm. Swarm mode must be enabled for these endpoints to work.

GET
/services
List services
ServiceList 2 params → 200500503
POST
/services/create
Create a service
ServiceCreate 2 params → 201400403409500503
GET
/services/{id}
Inspect a service
ServiceInspect 2 params → 200404500503
DELETE
/services/{id}
Delete a service
ServiceDelete 1 param → 200404500503
POST
/services/{id}/update
Update a service
ServiceUpdate 6 params → 200400404500503
GET
/services/{id}/logs
Get service logs
ServiceLogs 8 params → 200404500503

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are TaskSpec (10 properties), Mount (9 properties), Service (9 properties), ServiceSpec (8 properties). Each schema is shown below with its type and property counts.

HealthConfig
object
A test to perform to check that the container is healthy. Healthcheck commands should be side-effect free.
6 properties
ServiceSpec
object
User modifiable configuration for a service.
8 properties
ServiceCreateResponse
object
contains the information returned to a client on the creation of a new service.
2 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
GenericResources
array
User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1).
TaskSpec
object
User modifiable task configuration.
10 properties
ResourceObject
object
An object describing the resources which can be advertised by a node and requested by a task.
3 properties
Platform
object
Platform represents the platform (Arch/OS).
2 properties
NetworkAttachmentConfig
object
Specifies how a service should be attached to a particular network.
3 properties
PluginPrivilege
object
Describes a permission the user has to accept upon installing the plugin.
3 properties
EndpointSpec
object
Properties that can be configured to access and load balance a service.
2 properties
ErrorResponse
object
Represents an error.
1 property 1 required
Mount
object
9 properties
Service
object
9 properties
ServiceUpdateResponse
object
1 property
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…
Limit
object
An object describing a limit on resources which can be requested by a task.
3 properties
EndpointPortConfig
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

docker-service-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 Session API
Docker Swarm API
Docker System API
Where this information came from

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