Studio Project workflows for Docker Engine container, image, network, and volume lifecycle
Docker Engine is the core container runtime and daemon behind Docker — it manages the container, image, network, and volume lifecycle on a host via a REST API exposed over a Unix socket or TCP (optionally TLS-secured).
This project provides OpenAPI specs for automating against the Docker Engine REST API via an Integration Model. The -latest spec is a curated subset covering common CRUD for container automation — see OpenAPIs below.
| Asset | Description |
|---|---|
| OpenAPIs/ | Docker Engine REST API OpenAPI specs — curated -latest plus the full dated spec |
| Studio Projects/Docker Engine | 21 workflows covering common CRUD automation |
| Requirement | Version |
|---|---|
| Itential Platform | 6.x |
| Docker Engine | API version 1.33 (Docker 17.06+) |
| Docker Engine Integration Model | Required to build automation against the OpenAPI specs |
Import one of the OpenAPI specs from OpenAPIs/ as an Integration Model in Admin > Integrations, then create an integration pointing at your Docker daemon's exposed API endpoint.
Authentication is HTTP Basic, used for TLS-enabled remote Docker daemons:
Authorization: Basic <base64(username:password)> Local socket access typically requires no authentication. For remote/production access, expose the Docker daemon over TCP with TLS certificates configured (dockerd --tlsverify ...) and supply credentials enforced by your TLS/proxy layer, since the Docker Engine API itself has no native user database.
The instance's authentication/server properties should look like this once configured:
{
"authentication": {
"basicAuth": {
"username": "<your-username>",
"password": "<your-password>"
}
},
"server": {
"protocol": "https",
"host": "<your-host>",
"base_path": "/v1.33"
}
} | Spec | Version | Operations | Description |
|---|---|---|---|
docker_engine-latest.json | latest (curated) | 52 | Actively-maintained spec, trimmed to 52 of 105 upstream operations covering common CRUD for automation — see breakdown below |
docker_engine-1.33.json | 1.33 | 105 | Full spec for Docker Engine API 1.33 (105 operations) |
docker_engine-latest.jsonActively-maintained spec (x-vendor-api-version: 1.33). Trimmed to 52 of 105 upstream operations covering common CRUD for automation.
Resources included, by category:
Excluded as out of scope for this curated spec: Swarm mode and its orchestration objects (Swarm, Service, Task, Node, Secret, Config), plugin management, the experimental BuildKit session endpoint, Dockerfile-based image builds (/build, /commit), tar-based bulk image import/export, interactive container attach (stdin/stdout hijack), and admin/reporting-only endpoints (/auth, /events, /system/df). See the full spec below for these.
docker_engine-1.33.jsonFull, unmodified vendor spec for Docker Engine API 1.33 (105 operations) — the vendor's complete API surface, preserved as-is. See docker_engine-latest.json above for the curated subset if you just need common CRUD automation.
Backed by the Docker Engine:latest Integration Model (see docker_engine-latest.json above). The project contains 21 workflows organized into 4 folders, one atomic workflow per API operation, covering the common-CRUD subset of the curated spec.
| Folder | Workflows | Scope |
|---|---|---|
| Containers | List, Create, Inspect, Start, Stop, Delete Container | Container lifecycle |
| Images | List, Pull, Inspect, Tag, Delete Image | Image lifecycle |
| Networks | List, Create, Inspect, Delete, Connect, Disconnect Network | Network lifecycle and container attachment |
| Volumes | List, Create, Inspect, Delete Volume | Volume lifecycle |
| Dependency | Notes |
|---|---|
Docker Engine:latest Integration Model | Import from docker_engine-latest.json before importing the project |
Docker Engine integration instance | Create in Admin > Integrations with the connection properties above. Workflows are wired to an integration instance named Docker Engine — update the adapter_id value in each workflow task if yours is named differently |