# Docker Engine API API

> Docker Engine API API on Apizie: 104 endpoints (Ping, Check auth configuration, Build an image, Delete builder cache, …) returned as clean JSON through one API key. 104 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/dev-tools:docker-engine/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `dev-tools:docker-engine`
- Category: Dev Tools
- Status: live
- Source: https://docker.com
- Page: https://zieapi.vercel.app/api/dev-tools/docker-engine
- OpenAPI: https://zieapi.vercel.app/api/dev-tools/docker-engine/openapi.json

The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands…

## Endpoints

### Ping
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/system-ping`

### Check auth configuration
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/system-auth`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Build an image
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-build`

| Parameter | Type | Required | Description |
|---|---|---|---|
| dockerfile | string | no | Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`. |
| t | string | no | A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can… |
| extrahosts | string | no | Extra hosts to add to /etc/hosts |
| remote | string | no | A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called… |
| q | boolean | no | Suppress verbose build output. |
| nocache | boolean | no | Do not use the cache when building the image. |
| cachefrom | string | no | JSON array of images used for build cache resolution. |
| pull | string | no | Attempt to pull the image even if an older image exists locally. |
| rm | boolean | no | Remove intermediate containers after a successful build. |
| forcerm | boolean | no | Always remove intermediate containers, even upon failure. |
| memory | integer | no | Set memory limit for build. |
| memswap | integer | no | Total memory (memory + swap). Set as `-1` to disable swap. |
| cpushares | integer | no | CPU shares (relative weight). |
| cpusetcpus | string | no | CPUs in which to allow execution (e.g., `0-3`, `0,1`). |
| cpuperiod | integer | no | The length of a CPU period in microseconds. |
| cpuquota | integer | no | Microseconds of CPU time that the container can get in a CPU period. |
| buildargs | integer | no | JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment… |
| shmsize | integer | no | Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB. |
| squash | boolean | no | Squash the resulting images layers into a single layer. *(Experimental release only.)* |
| labels | string | no | Arbitrary key/value labels to set on the image, as a JSON map of string pairs. |
| networkmode | string | no | Sets the networking mode for the run commands during build. Supported standard values are: `bridge`, `host`, `none`, and `container: `.… |
| X-Registry-Config | string | no | This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to. The key is a registry… |

### Delete builder cache
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/build-prune`

### Create a new image from a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-commit`

| Parameter | Type | Required | Description |
|---|---|---|---|
| container | string | no | The ID or name of the container to commit |
| repo | string | no | Repository name for the created image |
| tag | string | no | Tag name for the create image |
| comment | string | no | Commit message |
| author | string | no | Author of the image (e.g., `John Hannibal Smith `) |
| pause | boolean | no | Whether to pause the container before committing |
| changes | string | no | `Dockerfile` instructions to apply while committing |
| body | object | no | JSON request body |

### List configs
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/config-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | A JSON encoded value of the filters (a `map[string][]string`) to process on the configs list. Available filters: - `id= ` - `label= or… |

### Create a config
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/config-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Inspect a config
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/config-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the config |

### Delete a config
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/config-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the config |

### Update a Config
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/config-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID or name of the config |
| version | integer | yes | The version number of the config object being updated. This is required to avoid conflicting writes. |
| body | object | no | JSON request body |

### Create a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no | Assign the specified name to the container. Must match `/?[a-zA-Z0-9_-]+`. |
| body | object | yes | JSON request body |

### List containers
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| all | boolean | no | Return all containers. By default, only running containers are shown |
| limit | integer | no | Return this number of most recently created containers, including non-running ones. |
| size | boolean | no | Return the size of container as fields `SizeRw` and `SizeRootFs`. |
| filters | string | no | Filters to process on the container list, encoded as JSON (a `map[string][]string`). For example, `{"status": ["paused"]}` will only… |

### Delete stopped containers
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-prune`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: - `until= ` Prune containers created… |

### Remove a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| v | boolean | no | Remove the volumes associated with the container. |
| force | boolean | no | If the container is running, kill it before removing it. |
| link | boolean | no | Remove the specified link associated with the container. |

### Get an archive of a filesystem resource in a container
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-archive`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| path | string | yes | Resource in the container’s filesystem to archive. |

### Extract an archive of files or folders to a directory in a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/put-container-archive`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| path | string | yes | Path to a directory in the container to extract the archive’s contents into. |
| noOverwriteDirNonDir | string | no | If “1”, “true”, or “True” then it will be an error if unpacking the given content would cause an existing directory to be replaced with a… |

### Attach to a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-attach`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| detachKeys | string | no | Override the key sequence for detaching a container.Format is a single character `[a-Z]` or `ctrl- ` where ` ` is one of: `a-z`, `@`, `^`,… |
| logs | boolean | no | Replay previous logs from the container. This is useful for attaching to a container that has started and you want to output everything… |
| stream | boolean | no | Stream attached streams from the time the request was made onwards |
| stdin | boolean | no | Attach to `stdin` |
| stdout | boolean | no | Attach to `stdout` |
| stderr | boolean | no | Attach to `stderr` |

### Attach to a container via a websocket
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-attach-websocket`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| detachKeys | string | no | Override the key sequence for detaching a container.Format is a single character `[a-Z]` or `ctrl- ` where ` ` is one of: `a-z`, `@`, `^`,… |
| logs | boolean | no | Return logs |
| stream | boolean | no | Return stream |
| stdin | boolean | no | Attach to `stdin` |
| stdout | boolean | no | Attach to `stdout` |
| stderr | boolean | no | Attach to `stderr` |

### Get changes on a container’s filesystem
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-changes`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |

### Create an exec instance
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-exec`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of container |
| body | object | yes | JSON request body |

### Export a container
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-export`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |

### Inspect a container
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| size | boolean | no | Return the size of container as fields `SizeRw` and `SizeRootFs` |

### Kill a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-kill`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| signal | string | no | Signal to send to the container as an integer or string (e.g. `SIGINT`) |

### Get container logs
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-logs`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| follow | boolean | no | Return the logs as a stream. This will return a `101` HTTP response with a `Connection: upgrade` header, then hijack the HTTP connection… |
| stdout | boolean | no | Return logs from `stdout` |
| stderr | boolean | no | Return logs from `stderr` |
| since | integer | no | Only return logs since this time, as a UNIX timestamp |
| timestamps | boolean | no | Add timestamps to every log line |
| tail | string | no | Only return this number of log lines from the end of the logs. Specify as an integer or `all` to output all log lines. |

### Pause a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-pause`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |

### Rename a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-rename`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| name | string | yes | New name for the container |

### Resize a container TTY
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-resize`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| h | integer | no | Height of the tty session in characters |
| w | integer | no | Width of the tty session in characters |

### Restart a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-restart`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| t | integer | no | Number of seconds to wait before killing the container |

### Start a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-start`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| detachKeys | string | no | Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl- ` where ` ` is one of: `a-z`, `@`,… |

### Get container stats based on resource usage
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-stats`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| stream | boolean | no | Stream the output. If false, the stats will be output once and then it will disconnect. |

### Stop a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-stop`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| t | integer | no | Number of seconds to wait before killing the container |

### List processes running inside a container
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-top`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| ps_args | string | no | The arguments to pass to `ps`. For example, `aux` |

### Unpause a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-unpause`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |

### Update a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| body | object | yes | JSON request body |

### Wait for a container
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/container-wait`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the container |
| condition | string | no | Wait until a container state reaches the given condition, either 'not-running' (default), 'next-exit', or 'removed'. |

### Get image information from the registry
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/distribution-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Image name or id |

### Monitor events
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/system-events`

| Parameter | Type | Required | Description |
|---|---|---|---|
| since | string | no | Show events created since this timestamp then stream new events. |
| until | string | no | Show events created until this timestamp then stop streaming. |
| filters | string | no | A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters: - `config= ` config name or ID… |

### Inspect an exec instance
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/exec-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Exec instance ID |

### Resize an exec instance
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/exec-resize`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Exec instance ID |
| h | integer | no | Height of the TTY session in characters |
| w | integer | no | Width of the TTY session in characters |

### Start an exec instance
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/exec-start`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Exec instance ID |
| body | object | no | JSON request body |

### Create an image
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| fromImage | string | no | Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is… |
| fromSrc | string | no | Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This… |
| repo | string | no | Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image. |
| tag | string | no | Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. |
| X-Registry-Auth | string | no | A base64-encoded auth configuration. [See the authentication section for details.](#section/Authentication) |

### Export several images
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-get-all`

| Parameter | Type | Required | Description |
|---|---|---|---|
| names | array | no | Image names to filter by |

### List Images
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| all | boolean | no | Show all images. Only images from a final layer (no children) are shown by default. |
| filters | string | no | A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `before`=(` [: ]`, ` `… |
| digests | boolean | no | Show digest information as a `RepoDigests` field on each image. |

### Import images
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-load`

| Parameter | Type | Required | Description |
|---|---|---|---|
| quiet | boolean | no | Suppress progress details during load. |

### Delete unused images
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-prune`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: - `dangling= ` When set to `true` (or… |

### Search images
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-search`

| Parameter | Type | Required | Description |
|---|---|---|---|
| term | string | yes | Term to search |
| limit | integer | no | Maximum number of results to return |
| filters | string | no | A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: -… |

### Remove an image
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Image name or ID |
| force | boolean | no | Remove the image even if it is being used by stopped containers or has other tags |
| noprune | boolean | no | Do not delete untagged parent images |

### Export an image
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-get`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Image name or ID |

### Get the history of an image
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-history`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Image name or ID |

### Inspect an image
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Image name or id |

### Push an image
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-push`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Image name or ID. |
| tag | string | no | The tag to associate with the image on the registry. |
| X-Registry-Auth | string | yes | A base64-encoded auth configuration. [See the authentication section for details.](#section/Authentication) |

### Tag an image
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/image-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Image name or ID to tag. |
| repo | string | no | The repository to tag in. For example, `someuser/someimage`. |
| tag | string | no | The name of the new tag. |

### Get system information
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/system-info`

### List networks
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/network-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | JSON encoded value of the filters (a `map[string][]string`) to process on the networks list. Available filters: - `driver= ` Matches a… |

### Create a network
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/network-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete unused networks
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/network-prune`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: - `until= ` Prune networks created… |

### Inspect a network
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/network-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Network ID or name |
| verbose | boolean | no | Detailed inspect output for troubleshooting |
| scope | string | no | Filter the network by scope (swarm, global, or local) |

### Remove a network
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/network-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Network ID or name |

### Connect a container to a network
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/network-connect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Network ID or name |

### Disconnect a container from a network
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/network-disconnect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Network ID or name |
| body | object | yes | JSON request body |

### List nodes
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/node-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | Filters to process on the nodes list, encoded as JSON (a `map[string][]string`). Available filters: - `id= ` - `label= ` -… |

### Inspect a node
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/node-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID or name of the node |

### Delete a node
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/node-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID or name of the node |
| force | boolean | no | Force remove a node from the swarm |

### Update a node
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/node-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the node |
| version | integer | yes | The version number of the node object being updated. This is required to avoid conflicting writes. |
| body | object | no | JSON request body |

### List plugins
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/plugin-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | A JSON encoded value of the filters (a `map[string][]string`) to process on the plugin list. Available filters: - `capability= ` -… |

### Create a plugin
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/plugin-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. |

### Get plugin privileges
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/get-plugin-privileges`

| Parameter | Type | Required | Description |
|---|---|---|---|
| remote | string | yes | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. |

### Install a plugin
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/plugin-pull`

| Parameter | Type | Required | Description |
|---|---|---|---|
| remote | string | yes | Remote reference for plugin to install. The `:latest` tag is optional, and is used as the default if omitted. |
| name | string | no | Local name for the pulled plugin. The `:latest` tag is optional, and is used as the default if omitted. |
| X-Registry-Auth | string | no | A base64-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for… |
| body | object | no | JSON request body |

### Remove a plugin
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/plugin-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. |
| force | boolean | no | Disable the plugin before removing. This may result in issues if the plugin is in use by a container. |

### Disable a plugin
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/plugin-disable`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. |

### Enable a plugin
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/plugin-enable`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. |
| timeout | integer | no | Set the HTTP client timeout (in seconds) |

### Inspect a plugin
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/plugin-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. |

### Push a plugin
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/plugin-push`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. |

### Configure a plugin
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/plugin-set`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. |
| body | object | no | JSON request body |

### Upgrade a plugin
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/plugin-upgrade`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. |
| remote | string | yes | Remote reference to upgrade to. The `:latest` tag is optional, and is used as the default if omitted. |
| X-Registry-Auth | string | no | A base64-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for… |
| body | object | no | JSON request body |

### List secrets
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/secret-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | A JSON encoded value of the filters (a `map[string][]string`) to process on the secrets list. Available filters: - `id= ` - `label= or… |

### Create a secret
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/secret-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Inspect a secret
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/secret-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the secret |

### Delete a secret
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/secret-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the secret |

### Update a Secret
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/secret-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID or name of the secret |
| version | integer | yes | The version number of the secret object being updated. This is required to avoid conflicting writes. |
| body | object | no | JSON request body |

### List services
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/service-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | A JSON encoded value of the filters (a `map[string][]string`) to process on the services list. Available filters: - `id= ` - `label= ` -… |

### Create a service
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/service-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Registry-Auth | string | no | A base64-encoded auth configuration for pulling from private registries. [See the authentication section for… |
| body | object | yes | JSON request body |

### Inspect a service
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/service-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of service. |
| insertDefaults | boolean | no | Fill empty fields with default values. |

### Delete a service
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/service-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of service. |

### Get service logs
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/service-logs`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of the service |
| details | boolean | no | Show service context and extra details provided to logs. |
| follow | boolean | no | Return the logs as a stream. This will return a `101` HTTP response with a `Connection: upgrade` header, then hijack the HTTP connection… |
| stdout | boolean | no | Return logs from `stdout` |
| stderr | boolean | no | Return logs from `stderr` |
| since | integer | no | Only return logs since this time, as a UNIX timestamp |
| timestamps | boolean | no | Add timestamps to every log line |
| tail | string | no | Only return this number of log lines from the end of the logs. Specify as an integer or `all` to output all log lines. |

### Update a service
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/service-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID or name of service. |
| version | integer | yes | The version number of the service object being updated. This is required to avoid conflicting writes. |
| registryAuthFrom | string | no | If the X-Registry-Auth header is not specified, this parameter indicates where to find registry authorization credentials. The valid… |
| rollback | string | no | Set to this parameter to `previous` to cause a server-side rollback to the previous service spec. The supplied spec will be ignored in… |
| X-Registry-Auth | string | no | A base64-encoded auth configuration for pulling from private registries. [See the authentication section for… |
| body | object | yes | JSON request body |

### Initialize interactive session
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/session`

### Inspect swarm
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/swarm-inspect`

### Initialize a new swarm
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/swarm-init`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Join an existing swarm
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/swarm-join`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Leave a swarm
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/swarm-leave`

| Parameter | Type | Required | Description |
|---|---|---|---|
| force | boolean | no | Force leave swarm, even if this is the last manager or that it will break the cluster. |

### Unlock a locked manager
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/swarm-unlock`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get the unlock key
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/swarm-unlockkey`

### Update a swarm
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/swarm-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| version | integer | yes | The version number of the swarm object being updated. This is required to avoid conflicting writes. |
| rotateWorkerToken | boolean | no | Rotate the worker join token. |
| rotateManagerToken | boolean | no | Rotate the manager join token. |
| rotateManagerUnlockKey | boolean | no | Rotate the manager unlock key. |
| body | object | yes | JSON request body |

### Get data usage information
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/system-data-usage`

### List tasks
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/task-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | A JSON encoded value of the filters (a `map[string][]string`) to process on the tasks list. Available filters: - `desired-state=(running /… |

### Inspect a task
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/task-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the task |

### Get task logs
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/task-logs`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the task |
| details | boolean | no | Show task context and extra details provided to logs. |
| follow | boolean | no | Return the logs as a stream. This will return a `101` HTTP response with a `Connection: upgrade` header, then hijack the HTTP connection… |
| stdout | boolean | no | Return logs from `stdout` |
| stderr | boolean | no | Return logs from `stderr` |
| since | integer | no | Only return logs since this time, as a UNIX timestamp |
| timestamps | boolean | no | Add timestamps to every log line |
| tail | string | no | Only return this number of log lines from the end of the logs. Specify as an integer or `all` to output all log lines. |

### Get version
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/system-version`

### List volumes
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/volume-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. Available filters: - `dangling= ` When set to… |

### Create a volume
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/volume-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete unused volumes
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/volume-prune`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filters | string | no | Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: - `label` (`label= `, `label= = `,… |

### Inspect a volume
`GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/volume-inspect`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Volume name or ID |

### Remove a volume
`POST https://zieapi.vercel.app/v1/dev-tools:docker-engine/volume-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Volume name or ID |
| force | boolean | no | Force the removal of the volume |

## Example
```
curl "https://zieapi.vercel.app/v1/dev-tools:docker-engine/system-ping" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Docker Engine API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/dev-tools:docker-engine/system-ping with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Docker Engine API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Docker Engine API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key dev-tools:docker-engine.

### What is the status of the Docker Engine API API?
Live: works with just an Apizie key