api

Nov 3, 2026

Changes in this version

type ContainerState

+ Sanction *Sanction

+ type Sanction struct

+ Attributes map[string]string

+ Module string

+ Time string

Nov 3, 2026

Changes in this version

+ const GPUMemoryCap

+ const GPUMemoryDefault

+ const GPUMemoryMax

+ const GPUMemoryOption

+ func CheckGPUMemory(n int64) error

type DeviceRequest

+ func GPURequestMemory(n int64) DeviceRequest

Oct 30, 2026

Changes in this version

+ type AttachOptions struct

+ DetachKeys string

+ Logs bool

+ Stdin io.Reader

type Client

+ func (c *Client) AttachWith(ctx context.Context, id string, o AttachOptions) (io.ReadCloser, error)

+ func (c *Client) ContainerResize(ctx context.Context, id string, height, width uint16) error

type ContainerConfig

+ AttachStderr bool

+ AttachStdin bool

+ AttachStdout bool

+ OpenStdin bool

+ StdinOnce bool

type HostConfig

+ ConsoleSize []uint16

Oct 29, 2026

Changes in this version

type ContainerConfig

+ Healthcheck *HealthConfig

type ContainerState

+ Health *Health

+ type Health struct

+ FailingStreak int

+ Log []HealthcheckResult

+ Status string

+ type HealthcheckResult struct

+ End string

+ ExitCode int

+ Output string

+ Start string

Oct 29, 2026

Changes in this version

type HostConfig

+ RestartPolicy *RestartPolicy

+ type RestartPolicy struct

+ MaximumRetryCount int

+ Name string

Oct 29, 2026

Changes in this version

type ContainerConfig

+ ExposedPorts map[string]struct{}

type HostConfig

+ PortBindings portmap.APIMap

+ PublishAllPorts bool

type NetworkSettings

+ Ports portmap.APIMap

+ type Port struct

+ IP string

+ PrivatePort uint16

+ PublicPort uint16

+ Type string

Oct 29, 2026

Changes in this version

type Client

+ func (c *Client) ContainersFiltered(ctx context.Context, all bool, filters Filters) ([]ContainerSummary, error)

+ func (c *Client) NetworksFiltered(ctx context.Context, filters Filters) ([]Network, error)

+ func (c *Client) VolumesFiltered(ctx context.Context, filters Filters) ([]Volume, error)

Oct 28, 2026

Changes in this version

type Client

+ func (c *Client) ExecCreate(ctx context.Context, container string, req ExecCreateRequest) (string, error)

+ func (c *Client) ExecInspect(ctx context.Context, id string) (ExecInspect, error)

+ func (c *Client) ExecResize(ctx context.Context, id string, height, width uint16) error

+ func (c *Client) ExecStart(ctx context.Context, id string, req ExecStartRequest, stdin io.Reader) (io.ReadCloser, error)

+ type ExecCreateRequest struct

+ AttachStderr bool

+ AttachStdin bool

+ AttachStdout bool

+ Cmd []string

+ ConsoleSize []uint16

+ DetachKeys string

+ Env []string

+ Privileged bool

+ Tty bool

+ User string

+ WorkingDir string

+ type ExecInspect struct

+ CanRemove bool

+ ContainerID string

+ DetachKeys string

+ ExitCode *int

+ ID string

+ OpenStderr bool

+ OpenStdin bool

+ OpenStdout bool

+ Pid int

+ ProcessConfig ProcessConfig

+ Running bool

+ type ExecStartRequest struct

+ ConsoleSize []uint16

+ Detach bool

+ Tty bool

+ type IDResponse struct

+ ID string

+ type ProcessConfig struct

+ Arguments []string

+ Entrypoint string

+ Privileged bool

+ Tty bool

+ User string

Oct 28, 2026

Changes in this version

+ type Filters map[string][]string

Oct 28, 2026

Changes in this version

type Client

+ func (c *Client) NetworkConnect(ctx context.Context, network, container string, aliases []string) error

+ func (c *Client) NetworkDisconnect(ctx context.Context, network, container string, force bool) error

+ func (c *Client) NetworkPrune(ctx context.Context, labels []string) (NetworkPruneResponse, error)

+ func (c *Client) StatPath(ctx context.Context, container, p string) (ContainerPathStat, error)

type ContainerCreateRequest

+ NetworkingConfig *NetworkingConfig

+ type ContainerPathStat struct

+ LinkTarget string

+ Mode uint32

+ Mtime string

+ Name string

+ Size int64

type EndpointSettings

+ Aliases []string

+ IPPrefixLen int

+ NetworkID string

+ type NetworkConnectRequest struct

+ Container string

+ EndpointConfig *EndpointSettings

+ type NetworkDisconnectRequest struct

+ Container string

+ Force bool

+ type NetworkPruneResponse struct

+ NetworksDeleted []string

+ type NetworkingConfig struct

+ EndpointsConfig map[string]*EndpointSettings

Oct 28, 2026

Changes in this version

+ var KnownCaps = []string

+ func DeviceCaps(reqs []DeviceRequest) ([]string, error)

+ type DeviceRequest struct

+ Capabilities [][]string

+ Count int

+ DeviceIDs []string

+ Driver string

+ Options map[string]string

+ func GPURequest() DeviceRequest

type HostConfig

+ DeviceRequests []DeviceRequest

Oct 28, 2026

Changes in this version

type Client

+ func (c *Client) Commit(ctx context.Context, o CommitOptions) (string, error)

+ func (c *Client) CopyFrom(ctx context.Context, container, p string) (io.ReadCloser, error)

+ func (c *Client) CopyTo(ctx context.Context, container, dir string, tarball io.Reader) error

+ func (c *Client) HTTP() (*http.Client, string)

+ func (c *Client) ImageLoad(ctx context.Context, layoutTar io.Reader) ([]string, error)

+ func (c *Client) ImageTag(ctx context.Context, source, repo, tag string) error

+ type CommitOptions struct

+ Author string

+ Changes []string

+ Comment string

+ Config *ImageConfig

+ Container string

+ Repo string

+ Tag string

+ type CommitResponse struct

+ ID string

+ type HealthConfig struct

+ Interval int64

+ Retries int

+ StartInterval int64

+ StartPeriod int64

+ Test []string

+ Timeout int64

+ type ImageConfig struct

+ ArgsEscaped bool

+ Cmd StrSlice

+ Entrypoint StrSlice

+ Env []string

+ ExposedPorts map[string]struct{}

+ Healthcheck *HealthConfig

+ Labels map[string]string

+ OnBuild []string

+ Shell []string

+ StopSignal string

+ User string

+ Volumes map[string]struct{}

+ WorkingDir string

+ type ImageHistory struct

+ Author string

+ Comment string

+ Created string

+ CreatedBy string

+ EmptyLayer bool

type ImageInspect

+ History []ImageHistory

type JSONMessage

+ Stream string

Oct 26, 2026

Changes in this version

type Client

+ func (c *Client) NetworkCreate(ctx context.Context, o NetworkCreateRequest) (NetworkCreateResponse, error)

+ func (c *Client) NetworkInspect(ctx context.Context, ref string) (json.RawMessage, error)

+ func (c *Client) NetworkRemove(ctx context.Context, ref string) error

+ func (c *Client) Networks(ctx context.Context) ([]Network, error)

type ContainerInspect

+ NetworkSettings NetworkSettings

+ type EndpointSettings struct

+ DNSNames []string

+ IPAddress string

type HostConfig

+ NetworkMode string

+ type Network struct

+ Attachable bool

+ Containers map[string]NetworkEndpoint

+ Created string

+ Driver string

+ EnableIPv6 bool

+ ID string

+ IPAM NetworkIPAM

+ Internal bool

+ Labels map[string]string

+ Name string

+ Options map[string]string

+ Scope string

+ type NetworkCreateRequest struct

+ Driver string

+ Internal bool

+ Labels map[string]string

+ Name string

+ Options map[string]string

+ type NetworkCreateResponse struct

+ ID string

+ Warning string

+ type NetworkEndpoint struct

+ IPv4Address string

+ Name string

+ type NetworkIPAM struct

+ Config []map[string]string

+ Driver string

+ type NetworkSettings struct

+ IPAddress string

+ Networks map[string]EndpointSettings

Oct 26, 2026

Changes in this version

type Client

+ func (c *Client) VolumeCreate(ctx context.Context, o VolumeCreateOptions) (Volume, error)

+ func (c *Client) VolumeInspect(ctx context.Context, name string) (json.RawMessage, error)

+ func (c *Client) VolumeRemove(ctx context.Context, name string, force bool) error

+ func (c *Client) Volumes(ctx context.Context) ([]Volume, error)

+ func (c *Client) VolumesPrune(ctx context.Context, all bool) (VolumePruneResponse, error)

type ContainerInspect

+ Mounts []MountPoint

type HostConfig

+ Binds []string

+ type MountPoint struct

+ Destination string

+ Driver string

+ Mode string

+ Name string

+ RW bool

+ Source string

+ Type string

+ type Volume struct

+ CreatedAt string

+ Driver string

+ Labels map[string]string

+ Mountpoint string

+ Name string

+ Options map[string]string

+ Scope string

+ UsageData *VolumeUsage

+ type VolumeCreateOptions struct

+ Driver string

+ DriverOpts map[string]string

+ Labels map[string]string

+ Name string

+ type VolumeListResponse struct

+ Volumes []Volume

+ Warnings []string

+ type VolumePruneResponse struct

+ SpaceReclaimed int64

+ VolumesDeleted []string

+ type VolumeUsage struct

+ RefCount int64

+ Size int64

Oct 26, 2026

Changes in this version

+ type BlkioEntry struct

+ Major uint64

+ Minor uint64

+ Op string

+ Value uint64

+ type BlkioStats struct

+ IOServiceBytesRecursive []BlkioEntry

+ type CPUStats struct

+ CPUUsage struct{ ... }

+ OnlineCPUs uint32

+ SystemCPUUsage uint64

type Client

+ func (c *Client) Stats(ctx context.Context, id string, stream bool, fn func(ContainerStats) error) error

+ type ContainerStats struct

+ BlkioStats BlkioStats

+ CPUStats CPUStats

+ ID string

+ MemoryStats MemoryStats

+ Name string

+ PidsStats PidsStats

+ PreCPUStats CPUStats

+ Preread string

+ Read string

+ Wctr WctrStatsInfo

+ type MemoryStats struct

+ Limit uint64

+ Usage uint64

+ type PidsStats struct

+ Current uint64

+ type WctrStatsInfo struct

+ CPU string

+ LogBytes int64

+ Running bool

+ SizeRw int64

Oct 26, 2026

Changes in this version

type Client

+ func (c *Client) Events(ctx context.Context, o EventsOptions, fn func(EventMessage) error) error

+ type EventActor struct

+ Attributes map[string]string

+ ID string

+ type EventMessage struct

+ Action string

+ Actor EventActor

+ Scope string

+ Time int64

+ TimeNano int64

+ Type string

+ type EventsOptions struct

+ Filters map[string][]string

+ Since string

+ Until string

Oct 26, 2026

Changes in this version

type Client

+ func (c *Client) Attach(ctx context.Context, id string) (io.ReadCloser, error)

+ func (c *Client) Restart(ctx context.Context, id string) error

+ func (c *Client) Stop(ctx context.Context, id string) error

Oct 26, 2026

Changes in this version

type Client

+ func (c *Client) Changes(ctx context.Context, id string) ([]FilesystemChange, error)

+ func (c *Client) DiskUsage(ctx context.Context) (SystemDataUsage, error)

+ func (c *Client) PruneContainers(ctx context.Context) (ContainerPruneResponse, error)

+ func (c *Client) PruneImages(ctx context.Context, all bool) (ImagePruneResponse, error)

+ type ContainerPruneResponse struct

+ ContainersDeleted []string

+ SpaceReclaimed int64

+ type FilesystemChange struct

+ Kind int

+ Path string

+ type ImagePruneResponse struct

+ ImagesDeleted []ImageDeleteResponseItem

+ SpaceReclaimed int64

+ type StorageUsage struct

+ Error string

+ Kind string

+ Persistent bool

+ Quota int64

+ Usage int64

+ type SystemDataUsage struct

+ BuildCache []any

+ Containers []ContainerSummary

+ Images []ImageSummary

+ LayersSize int64

+ Storage *StorageUsage

+ Volumes []any

Oct 26, 2026

Changes in this version

+ const APIVersion

+ const DefaultSocket

+ const HostEnv

+ const MinAPIVersion

+ const StreamStderr

+ const StreamStdin

+ const StreamStdout

+ var ErrBadFrame = errors.New("malformed multiplexed stream")

+ func DefaultHost() string

+ func Demux(stdout, stderr io.Writer, r io.Reader) error

+ func IsNotFound(err error) bool

+ func WriteFrame(w io.Writer, stream byte, p []byte) error

+ type Client struct

+ func NewClient(host string) (*Client, error)

+ func NewClientWith(hc *http.Client, base string) *Client

+ func (c *Client) Containers(ctx context.Context, all bool) ([]ContainerSummary, error)

+ func (c *Client) Create(ctx context.Context, name string, req ContainerCreateRequest) (ContainerCreateResponse, error)

+ func (c *Client) ImageInspect(ctx context.Context, ref string) (json.RawMessage, error)

+ func (c *Client) Images(ctx context.Context) ([]ImageSummary, error)

+ func (c *Client) Inspect(ctx context.Context, id string) (json.RawMessage, error)

+ func (c *Client) Kill(ctx context.Context, id string) error

+ func (c *Client) Logs(ctx context.Context, id string, follow bool) (io.ReadCloser, error)

+ func (c *Client) Ping(ctx context.Context) error

+ func (c *Client) Pull(ctx context.Context, ref string, progress func(JSONMessage)) error

+ func (c *Client) Remove(ctx context.Context, id string, force bool) error

+ func (c *Client) RemoveImage(ctx context.Context, ref string, force bool) ([]ImageDeleteResponseItem, error)

+ func (c *Client) Start(ctx context.Context, id string) error

+ func (c *Client) Version(ctx context.Context) (SystemVersion, error)

+ func (c *Client) Wait(ctx context.Context, id, condition string) (*Waiter, error)

+ type ContainerConfig struct

+ Cmd StrSlice

+ Entrypoint StrSlice

+ Env []string

+ Image string

+ Labels map[string]string

+ Tty bool

+ WorkingDir string

+ type ContainerCreateRequest struct

+ HostConfig HostConfig

+ type ContainerCreateResponse struct

+ ID string

+ Warnings []string

+ type ContainerInspect struct

+ Args []string

+ Config ContainerConfig

+ Created string

+ Driver string

+ HostConfig HostConfig

+ ID string

+ Image string

+ Name string

+ Path string

+ Platform string

+ RestartCount int

+ SizeRw int64

+ State ContainerState

+ type ContainerState struct

+ Dead bool

+ Error string

+ ExitCode int

+ FinishedAt string

+ OOMKilled bool

+ Paused bool

+ Pid int

+ Restarting bool

+ Running bool

+ StartedAt string

+ Status string

+ type ContainerSummary struct

+ Command string

+ Created int64

+ HostConfig struct{ ... }

+ ID string

+ Image string

+ ImageID string

+ Labels map[string]string

+ Names []string

+ Ports []any

+ SizeRw int64

+ State string

+ Status string

+ type ContainerWaitExitError struct

+ Message string

+ type ContainerWaitResponse struct

+ Error *ContainerWaitExitError

+ StatusCode int64

+ type ErrDaemon struct

+ Message string

+ Status int

+ func (e *ErrDaemon) Error() string

+ type ErrorResponse struct

+ Message string

+ type HostConfig struct

+ AutoRemove bool

+ Memory int64

+ type ImageDeleteResponseItem struct

+ Deleted string

+ Untagged string

+ type ImageInspect struct

+ Architecture string

+ Author string

+ Config ContainerConfig

+ Created string

+ Descriptor *json.RawMessage

+ ID string

+ Metadata map[string]any

+ Os string

+ RepoDigests []string

+ RepoTags []string

+ RootFS map[string]any

+ Size int64

+ type ImageSummary struct

+ Containers int64

+ Created int64

+ ID string

+ Labels map[string]string

+ ParentID string

+ RepoDigests []string

+ RepoTags []string

+ SharedSize int64

+ Size int64

+ type JSONMessage struct

+ Error string

+ ErrorDetail *JSONMsgError

+ ID string

+ Status string

+ type JSONMsgError struct

+ Message string

+ type StrSlice []string

+ func (s *StrSlice) UnmarshalJSON(b []byte) error

+ type SystemVersion struct

+ APIVersion string

+ Arch string

+ BuildTime string

+ GitCommit string

+ GoVersion string

+ KernelVersion string

+ MinAPIVersion string

+ Os string

+ Platform struct{ ... }

+ Version string

+ type Waiter struct

+ func (w *Waiter) Result() (ContainerWaitResponse, error)