You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
WaitContainer takes the name of ID of a container and waits until the container stops. Upon stopping, the return
code of the container is returned. If the container container cannot be found by ID or name,
a ContainerNotFound error is returned.
RemoveContainer takes requires the name or ID of container as well a boolean representing whether a running
container can be stopped and removed. Upon sucessful removal of the container, its ID is returned. If the
container cannot be found by name or ID, an ContainerNotFound error will be returned.
SearchImage takes the string of an image name and a limit of searches from each registries to be returned. SearchImage
will then use a glob-like match to find the image you are searching for. The images are returned in an array of
ImageSearch structures which contain information about the image as well as its fully-qualified name.
ListContainers returns a list of containers in no particular order. There are
returned as an array of ListContainerData structs. See also GetContainer.
StopContainer stops a container given a timeout. It takes the name or ID of a container as well as a
timeout value. The timeout value the time before a forceable stop to the container is applied. It
returns the container ID once stopped. If the container cannot be found, a ContainerNotFound
error will be returned instead. See also KillContainer.
PauseContainer takes the name or ID of container and pauses it. If the container cannot be found,
a ContainerNotFound error will be returned; otherwise the ID of the container is returned.
See also UnpauseContainer.
ListContainerProcesses takes a name or ID of a container and returns the processes
running inside the container as array of strings. It will accept an array of string
arguements that represent ps options. If the container cannot be found, a ContainerNotFound
error will be returned.
RestartContainer will restart a running container given a container name or ID and timeout value. The timeout
value is the time before a forceable stop is used to stop the container. If the container cannot be found by
name or ID, a ContainerNotFound error will be returned; otherwise, the ID of the
container will be returned.
ImportImage imports an image from a source (like tarball) into local storage. The image can have additional
descriptions added to it using the message and changes options. See also ExportImage.
GetContainer takes a name or ID of a container and returns single ListContainerData
structure. A ContainerNotFound error will be returned if the container cannot be found.
See also ListContainers and InspectContainer.
ListContainerChanges takes a name or ID of a container and returns changes between the container and
its base image. The return values are expressed as string maps where a path -> the change. If the
container cannot be found, a ContainerNotFound error will be returned.
GetContainerStats takes the name or ID of a container and returns a single ContainerStats structure which
contains attributes like memory and cpu usage. If the container cannot be found, a
ContainerNotFound error will be returned.
InspectImage takes the name or ID of an image and returns a string respresentation of data associated with the
mage. You must serialize the string into JSON to use it further. An ImageNotFound error will
be returned if the image cannot be found.
UnpauseContainer takes the name or ID of container and unpauses a paused container. If the container cannot be
found, a ContainerNotFound error will be returned; otherwise the ID of the container is returned.
See also PauseContainer.
InspectContainer data takes a name or ID of a container returns the inspection
data in string format. You can then serialize the string into JSON. A ContainerNotFound
error will be returned if the container cannot be found. See also InspectImage.
GetContainerLogs takes a name or ID of a container and returns the logs of that container.
If the container cannot be found, a ContainerNotFound error will be returned.
The container logs are returned as an array of strings. GetContainerLogs will honor the streaming
capability of varlink if the client invokes it.
KillContainer takes the name or ID of a container as well as a signal to be applied to the container. Once the
container has been killed, the container's ID is returned. If the container cannot be found, a
ContainerNotFound error is returned. See also StopContainer.
HistoryImage takes the name or ID of an image and returns information about its history and layers. The returned
history is in the form of an array of ImageHistory structures. If the image cannot be found, an
ImageNotFound error is returned.
TagImage takes the name or ID of an image in local storage as well as the desired tag name. If the image cannot
be found, an ImageNotFound error will be returned; otherwise, the ID of the image is returned on success.
RemoveImage takes the name or ID of an image as well as a booleon that determines if containers using that image
should be deleted. If the image cannot be found, an ImageNotFound error will be returned. The
D of the removed image is returned when complete. See also DeleteUnusedImages.
ExportImage takes the name or ID of an image and exports it to a destination like a tarball. There is also
a booleon option to force compression. Upon completion, the ID of the image is returned. If the image cannot
be found in local storage, an ImageNotFound error will be returned. See also ImportImage.
ExportContainer creates an image from a container. It takes the name or ID of a container and a
path representing the target tarfile. If the container cannot be found, a ContainerNotFound
error will be returned.
The return value is the written tarfile.
PushImage takes three input arguments: the name or ID of an image, the fully-qualified destination name of the image,
and a boolean as to whether tls-verify should be used. It will return an ImageNotFound error if
the image cannot be found in local storage; otherwise the ID of the image will be returned on success.