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 map directly to API endpoints (e.g. docker ps
is GET /containers/json). The notable exception is running containers,
which consists of several API calls.
```rust
async fn list_containers(config: &Configuration) {
let containers = container_list(config, Some(true), None, None, None);
match containers.await {
Ok(container_summary) => {
for c in container_summary {
println!("{:?}", c.names);
}
}
Err(err) => {
panic!("{}", err)
}
}
}
fn main() { println!("DOCKER");
let config = &Configuration {
base_path: "http://127.0.0.1:2375".to_string(),
user_agent: None,
client: reqwest::Client::new(),
basic_auth: None,
oauth_access_token: None,
bearer_access_token: None,
api_key: None,
};
tokio::runtime::Builder::new_multi_thread()
.enable_all()
.build()
.unwrap()
.block_on(async {
list_containers(config).await;
})
}
```
bash
cargo add docker-rust-api
The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:
{
\"message\": \"page not found\"
}
The API is usually changed in each release, so API calls are versioned to
ensure that clients don't break. To lock to a specific version of the API,
you prefix the URL with its version, for example, call /v1.30/info to use
the v1.30 version of the /info endpoint. If the API version specified in
the URL is not supported by the daemon, a HTTP 400 Bad Request error message
is returned.
If you omit the version-prefix, the current version of the API (v1.42) is used.
For example, calling /info is the same as calling /v1.42/info. Using the
API without a version-prefix is deprecated and will be removed in a future release.
Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine.
The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons.
Authentication for registries is handled client side. The client has to send
authentication details to various endpoints that need to communicate with
registries, such as POST /images/(name)/push. These are sent as
X-Registry-Auth header as a base64url encoded
(JSON) string with the following structure:
{
\"username\": \"string\",
\"password\": \"string\",
\"email\": \"string\",
\"serveraddress\": \"string\"
}
The serveraddress is a domain/IP without a protocol. Throughout this
structure, double quotes are required.
If you have already got an identity token from the /auth endpoint,
you can just pass this instead of credentials:
{
\"identitytoken\": \"9cbaf023786cd7...\"
}
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
org.openapitools.codegen.languages.RustClientCodegenPut the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./openapi" }
All URIs are relative to http://localhost/v1.42
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ConfigApi | configcreate | POST /configs/create | Create a config *ConfigApi* | configdelete | DELETE /configs/{id} | Delete a config ConfigApi | configinspect | GET /configs/{id} | Inspect a config *ConfigApi* | configlist | GET /configs | List configs ConfigApi | configupdate | POST /configs/{id}/update | Update a Config *ContainerApi* | containerarchive | GET /containers/{id}/archive | Get an archive of a filesystem resource in a container ContainerApi | containerarchiveinfo | HEAD /containers/{id}/archive | Get information about files in a container ContainerApi | containerattach | POST /containers/{id}/attach | Attach to a container *ContainerApi* | containerattachwebsocket | GET /containers/{id}/attach/ws | Attach to a container via a websocket *ContainerApi* | containerchanges | GET /containers/{id}/changes | Get changes on a container’s filesystem ContainerApi | containercreate | POST /containers/create | Create a container *ContainerApi* | containerdelete | DELETE /containers/{id} | Remove a container ContainerApi | containerexport | GET /containers/{id}/export | Export a container *ContainerApi* | containerinspect | GET /containers/{id}/json | Inspect a container ContainerApi | containerkill | POST /containers/{id}/kill | Kill a container *ContainerApi* | containerlist | GET /containers/json | List containers ContainerApi | containerlogs | GET /containers/{id}/logs | Get container logs *ContainerApi* | containerpause | POST /containers/{id}/pause | Pause a container ContainerApi | containerprune | POST /containers/prune | Delete stopped containers *ContainerApi* | containerrename | POST /containers/{id}/rename | Rename a container ContainerApi | containerresize | POST /containers/{id}/resize | Resize a container TTY *ContainerApi* | containerrestart | POST /containers/{id}/restart | Restart a container ContainerApi | containerstart | POST /containers/{id}/start | Start a container *ContainerApi* | containerstats | GET /containers/{id}/stats | Get container stats based on resource usage ContainerApi | containerstop | POST /containers/{id}/stop | Stop a container *ContainerApi* | containertop | GET /containers/{id}/top | List processes running inside a container ContainerApi | containerunpause | POST /containers/{id}/unpause | Unpause a container *ContainerApi* | containerupdate | POST /containers/{id}/update | Update a container ContainerApi | containerwait | POST /containers/{id}/wait | Wait for a container *ContainerApi* | putcontainerarchive | PUT /containers/{id}/archive | Extract an archive of files or folders to a directory in a container *DistributionApi* | distributioninspect | GET /distribution/{name}/json | Get image information from the registry ExecApi | containerexec | POST /containers/{id}/exec | Create an exec instance *ExecApi* | execinspect | GET /exec/{id}/json | Inspect an exec instance ExecApi | execresize | POST /exec/{id}/resize | Resize an exec instance *ExecApi* | execstart | POST /exec/{id}/start | Start an exec instance ImageApi | buildprune | POST /build/prune | Delete builder cache *ImageApi* | imagebuild | POST /build | Build an image ImageApi | imagecommit | POST /commit | Create a new image from a container *ImageApi* | imagecreate | POST /images/create | Create an image ImageApi | imagedelete | DELETE /images/{name} | Remove an image *ImageApi* | imageget | GET /images/{name}/get | Export an image ImageApi | imagegetall | GET /images/get | Export several images ImageApi | imagehistory | GET /images/{name}/history | Get the history of an image *ImageApi* | imageinspect | GET /images/{name}/json | Inspect an image ImageApi | imagelist | GET /images/json | List Images *ImageApi* | imageload | POST /images/load | Import images ImageApi | imageprune | POST /images/prune | Delete unused images *ImageApi* | imagepush | POST /images/{name}/push | Push an image ImageApi | imagesearch | GET /images/search | Search images *ImageApi* | imagetag | POST /images/{name}/tag | Tag an image NetworkApi | networkconnect | POST /networks/{id}/connect | Connect a container to a network *NetworkApi* | networkcreate | POST /networks/create | Create a network NetworkApi | networkdelete | DELETE /networks/{id} | Remove a network *NetworkApi* | networkdisconnect | POST /networks/{id}/disconnect | Disconnect a container from a network NetworkApi | networkinspect | GET /networks/{id} | Inspect a network *NetworkApi* | networklist | GET /networks | List networks NetworkApi | networkprune | POST /networks/prune | Delete unused networks *NodeApi* | nodedelete | DELETE /nodes/{id} | Delete a node NodeApi | nodeinspect | GET /nodes/{id} | Inspect a node *NodeApi* | nodelist | GET /nodes | List nodes NodeApi | nodeupdate | POST /nodes/{id}/update | Update a node *PluginApi* | getpluginprivileges | GET /plugins/privileges | Get plugin privileges *PluginApi* | plugincreate | POST /plugins/create | Create a plugin PluginApi | plugindelete | DELETE /plugins/{name} | Remove a plugin *PluginApi* | plugindisable | POST /plugins/{name}/disable | Disable a plugin PluginApi | pluginenable | POST /plugins/{name}/enable | Enable a plugin *PluginApi* | plugininspect | GET /plugins/{name}/json | Inspect a plugin PluginApi | pluginlist | GET /plugins | List plugins *PluginApi* | pluginpull | POST /plugins/pull | Install a plugin PluginApi | pluginpush | POST /plugins/{name}/push | Push a plugin *PluginApi* | pluginset | POST /plugins/{name}/set | Configure a plugin PluginApi | pluginupgrade | POST /plugins/{name}/upgrade | Upgrade a plugin *SecretApi* | secretcreate | POST /secrets/create | Create a secret SecretApi | secretdelete | DELETE /secrets/{id} | Delete a secret *SecretApi* | secretinspect | GET /secrets/{id} | Inspect a secret SecretApi | secretlist | GET /secrets | List secrets *SecretApi* | secretupdate | POST /secrets/{id}/update | Update a Secret ServiceApi | servicecreate | POST /services/create | Create a service *ServiceApi* | servicedelete | DELETE /services/{id} | Delete a service ServiceApi | serviceinspect | GET /services/{id} | Inspect a service *ServiceApi* | servicelist | GET /services | List services ServiceApi | servicelogs | GET /services/{id}/logs | Get service logs *ServiceApi* | serviceupdate | POST /services/{id}/update | Update a service SessionApi | session | POST /session | Initialize interactive session SwarmApi | swarminit | POST /swarm/init | Initialize a new swarm *SwarmApi* | swarminspect | GET /swarm | Inspect swarm SwarmApi | swarmjoin | POST /swarm/join | Join an existing swarm *SwarmApi* | swarmleave | POST /swarm/leave | Leave a swarm SwarmApi | swarmunlock | POST /swarm/unlock | Unlock a locked manager *SwarmApi* | swarmunlockkey | GET /swarm/unlockkey | Get the unlock key SwarmApi | swarmupdate | POST /swarm/update | Update a swarm *SystemApi* | systemauth | POST /auth | Check auth configuration SystemApi | systemdatausage | GET /system/df | Get data usage information SystemApi | systemevents | GET /events | Monitor events *SystemApi* | systeminfo | GET /info | Get system information SystemApi | systemping | GET /ping | Ping SystemApi | systempinghead | HEAD /ping | Ping *SystemApi* | systemversion | GET /version | Get version TaskApi | taskinspect | GET /tasks/{id} | Inspect a task *TaskApi* | tasklist | GET /tasks | List tasks TaskApi | tasklogs | GET /tasks/{id}/logs | Get task logs *VolumeApi* | volumecreate | POST /volumes/create | Create a volume VolumeApi | volumedelete | DELETE /volumes/{name} | Remove a volume *VolumeApi* | volumeinspect | GET /volumes/{name} | Inspect a volume VolumeApi | volumelist | GET /volumes | List volumes *VolumeApi* | volumeprune | POST /volumes/prune | Delete unused volumes VolumeApi | volume_update | PUT /volumes/{name} | \"Update a volume. Valid only for Swarm cluster volumes\"
To get access to the crate's generated documentation, use:
cargo doc --open