api

README

This directory contains code pertaining to the Docker API:

• Used by the docker client when communicating with the docker daemon

• Used by third party tools wishing to interface with the docker daemon

Documentation

Index

• Constants
• func DisplayablePorts(ports *engine.Table) string
• func FormGroup(key string, start, last int) string
• func LoadOrCreateTrustKey(trustKeyPath string) (libtrust.PrivateKey, error)
• func MatchesContentType(contentType, expectedType string) bool
• func ValidateHost(val string) (string, error)

Constants

const (
	APIVERSION            version.Version = "1.19"                 // Current REST API version
	DEFAULTHTTPHOST                       = "127.0.0.1"            // Default HTTP Host used if only port is provided to -H flag e.g. docker -d -H tcp://:8080
	DEFAULTUNIXSOCKET                     = "/var/run/docker.sock" // Docker daemon by default always listens on the default unix socket
	DefaultDockerfileName string          = "Dockerfile"           // Default filename with Docker commands, read by docker build
)

Common constants for daemon and client.

Functions

func DisplayablePorts

func DisplayablePorts(ports *engine.Table) string

TODO remove, used on < 1.5 in getContainersJSON

func FormGroup

func FormGroup(key string, start, last int) string

func LoadOrCreateTrustKey

func LoadOrCreateTrustKey(trustKeyPath string) (libtrust.PrivateKey, error)

LoadOrCreateTrustKey attempts to load the libtrust key at the given path, otherwise generates a new one

func MatchesContentType

func MatchesContentType(contentType, expectedType string) bool

func ValidateHost

func ValidateHost(val string) (string, error)