engine-api: github.com/docker/engine-api Index | Files | Directories

package engineapi

import "github.com/docker/engine-api"

Package engineapi provides libraries to implement client and server components compatible with the Docker engine.

The client package in github.com/docker/engine-api/client implements all necessary requests to implement the official Docker engine cli.

Create a new client, then use it to send and receive messages to the Docker engine API:

defaultHeaders := map[string]string{"User-Agent": "engine-api-cli-1.0"}
cli, err := client.NewClient("unix:///var/run/docker.sock", "v1.22", nil, defaultHeaders)

Other programs, like Docker Machine, can set the default Docker engine environment for you. There is a shortcut to use its variables to configure the client:

cli, err := client.NewEnvClient()

All request arguments are defined as typed structures in the types package. For instance, this is how to get all containers running in the host:

options := types.ContainerListOptions{All: true}
containers, err := cli.ContainerList(context.Background(), options)

Index

Package Files

doc.go

Directories

PathSynopsis
client
client/transportPackage transport provides function to send request to remote endpoints.
client/transport/cancellablePackage cancellable provides helper function to cancel http requests.
typesPackage types is used for API stability in the types and response to the consumers of the API stats endpoint.
types/blkiodev
types/container
types/events
types/filtersPackage filters provides helper function to parse and handle command line filter, used for example in docker ps or docker images commands.
types/mount
types/network
types/reference
types/registry
types/strslice
types/swarm
types/time
types/versions
types/versions/v1p19Package v1p19 provides specific API types for the API version 1, patch 19.
types/versions/v1p20Package v1p20 provides specific API types for the API version 1, patch 20.

Updated 2018-03-28. Refresh now. Tools for package owners. This is an inactive package (no imports and no commits in at least two years).