Attach takes the name or ID of a container and sets up the ability to remotely attach to its console.

BuildImage takes a [BuildInfo](#BuildInfo) structure and builds an image.

BuildImageHierarchyMap is for the development of Podman and should not be used.

BuildInfo is used to describe user input for building images.

BuildOptions are are used to describe describe physical attributes of the build.

Commit, creates an image from an existing container.

ContainerArtifacts returns a container's artifacts in string form.

ContainerChanges describes the return struct for ListContainerChanges.

ContainerCheckPoint performs a checkpopint on a container by its name or full/partial container ID.

ContainerConfig returns a container's config in string form.

ContainerExists takes a full or partial container ID or name and returns an int as to whether the container exists in local storage.

ContainerInspectData returns a container's inspect data in string form.

ContainerMount describes the struct for mounts in a container.

ContainerNamespace describes the namespace structure for an existing container.

ContainerNotFound means the container could not be found by the provided name or ID in local storage.

ContainerPortMappings describes the struct for portmappings in an existing container.

ContainerRestore restores a container that has been checkpointed.

ContainerRunlabel runs executes a command as described by a given container image label.

ContainerStateData returns a container's state config in string form.

ContainerStats is the return struct for the stats of a container.

Create is an input structure for creating containers.

CreateContainer creates a new container from an image.

This call is for the development of Podman only and should not be used.

CreatePod creates a new empty pod.

DeleteStoppedContainers will delete all containers that are not running.

DeleteUnusedImages deletes any images not associated with a container.

Diff returns a diff between libpod objects.

Container is already stopped.

ErrorOccurred is a generic error for an error that occurs during the execution.

This function requires CGroupsV2 to run in rootless mode.

Event describes a libpod struct.

EvictContainer requires the name or ID of a container as well as a boolean that indicates to remove builtin volumes.

ExecContainer executes a command in the given container.

ExportContainer creates an image from a container.

ExportImage takes the name or ID of an image and exports it to a destination like a tarball.

GenerateKube generates a Kubernetes v1 Pod description of a Podman container or pod and its containers.

GetAttachSockets takes the name or ID of an existing container.

GetContainer returns information about a single container.

GetContainerLogs takes a name or ID of a container and returns the logs of that container.

GetContainersByContext allows you to get a list of container ids depending on all, latest, or a list of container names.

GetContainerStats takes the name or ID of a container and returns a single ContainerStats structure which contains attributes like memory and cpu usage.

GetContainerStatsWithHistory takes a previous set of container statistics and uses libpod functions to calculate the containers statistics based on current and previous measurements.

GetEvents returns known libpod events filtered by the options provided.

GetImage returns information about a single image in storage.

GetInfo returns a [PodmanInfo](#PodmanInfo) struct that describes podman and its host such as storage stats, build information of Podman, and system-wide registries.

GetLayersMapWithImageInfo is for the development of Podman and should not be used.

GetPod takes a name or ID of a pod and returns single [ListPodData](#ListPodData) structure.

GetPodsByContext allows you to get a list pod ids depending on all, latest, or a list of pod names.

GetPodsByStatus searches for pods whose status is included in statuses.

GetPodStats takes the name or ID of a pod and returns a pod name and slice of ContainerStats structure which contains attributes like memory and cpu usage.

GetVersion returns version and build information of the podman service.

GetVolumes gets slice of the volumes on a remote host.

HealthCheckRun executes defined container's healthcheck command and returns the container's health status.

HistoryImage takes the name or ID of an image and returns information about its history and layers.

ImageExists talks a full or partial image ID or name and returns an int as to whether the image exists in local storage.

ImageHistory describes the returned structure from ImageHistory.

ImageNotFound means the image could not be found by the provided name or ID in local storage.

ImageSave allows you to save an image from the local image storage to a tarball.

Represents a single search result from SearchImages.

ImagesPrune removes all unused images from the local store.

ImportImage imports an image from a source (like tarball) into local storage.

InfoDistribution describes the host's distribution.

InfoGraphStatus describes the detailed status of the storage driver.

InfoHost describes the host stats portion of PodmanInfo.

InfoPodman provides details on the Podman binary.

InfoStore describes the host's storage informatoin.

InitContainer initializes the given container.

InspectContainer data takes a name or ID of a container returns the inspection data in string format.

InspectImage takes the name or ID of an image and returns a string representation of data associated with the mage.

InspectPod takes the name or ID of an image and returns a string representation of data associated with the pod.

InvalidState indicates that a container or pod was in an improper state for the requested operation.

KillContainer takes the name or ID of a container as well as a signal to be applied to the container.

KillPod takes the name or ID of a pod as well as a signal to be applied to the pod.

ListContainerChanges takes a name or ID of a container and returns changes between the container and its base image.

ListContainerMounts gathers all the mounted container mount points and returns them as an array of strings #### Example ~~~ $ varlink call unix:/run/podman/io.podman/io.podman.ListContainerMounts { "mounts": { "04e4c255269ed2545e7f8bd1395a75f7949c50c223415c00c1d54bfa20f3b3d9": "/var/lib/containers/storage/overlay/a078925828f57e20467ca31cfca8a849210d21ec7e5757332b72b6924f441c17/merged", "1d58c319f9e881a644a5122ff84419dccf6d138f744469281446ab243ef38924": "/var/lib/containers/storage/overlay/948fcf93f8cb932f0f03fd52e3180a58627d547192ffe3b88e0013b98ddcd0d2/merged" } } ~~~.

ListContainerProcesses takes a name or ID of a container and returns the processes running inside the container as array of strings.

ListContainers returns information about all containers.

ListImages returns information about the images that are currently in storage.

ListPodContainerInfo is a returned struct for describing containers in a pod.

ListPodData is the returned struct for an individual pod.

ListPods returns a list of pods in no particular order.

LoadImage allows you to load an image into local storage from a tarball.

MoreResponse is a struct for when responses from varlink requires longer output.

MountContainer mounts a container by name or full/partial ID.

NoContainerRunning means none of the containers requested are running in a command that requires a running container.

NoContainersInPod means a pod has no containers on which to perform the operation.

PauseContainer takes the name or ID of container and pauses it.

PausePod takes the name or ID of a pod and pauses the running containers associated with it.

PodContainerError means a container associated with a pod failed to perform an operation.

PodCreate is an input structure for creating pods.

PodmanInfo describes the Podman host and build.

PodNotFound means the pod could not be found by the provided name or ID in local storage.

PodStateData returns inspectr level information of a given pod in string form.

PullImage pulls an image from a repository to local storage.

PushImage takes two input arguments: the name or ID of an image, the fully-qualified destination name of the image, It will return an [ImageNotFound](#ImageNotFound) error if the image cannot be found in local storage; otherwise it will return a [MoreResponse](#MoreResponse).

ReceiveFile allows the host to send a remote client a file.

RemoveContainer requires the name or ID of a container as well as a boolean that indicates whether a container should be forcefully removed (e.g., by stopping it), and a boolean indicating whether to remove builtin volumes.

RemoveImage takes the name or ID of an image as well as a boolean that determines if containers using that image should be deleted.

RemovePod takes the name or ID of a pod as well a boolean representing whether a running container in the pod can be stopped and removed.

RestartContainer will restart a running container given a container name or ID and timeout value.

RestartPod will restart containers in a pod given a pod name or ID.

Runlabel describes the required input for container runlabel.

RuntimeErrors generally means a runtime could not be found or gotten.

SearchImages searches available registries for images that contain the contents of "query" in their name.

Sendfile allows a remote client to send a file to the host.

Sockets describes sockets location for a container.

Spec returns the oci spec for a container.

StartContainer starts a created or stopped container.

StartPod starts containers in a pod.

StopContainer stops a container given a timeout.

StopPod stops containers in a pod.

TagImage takes the name or ID of an image in local storage as well as the desired tag name.

UnmountContainer umounts a container by its name or full/partial container ID.

UnpauseContainer takes the name or ID of container and unpauses a paused container.

UnpausePod takes the name or ID of a pod and unpauses the paused containers associated with it.

VolumeCreate creates a volume on a remote host.

VolumeNotFound means the volume could not be found by the name or ID in local storage.

VolumeRemove removes a volume on a remote host.

VolumesPrune removes unused volumes on the host.

WaitContainer takes the name or ID of a container and waits the given interval in milliseconds until the container stops.

The Podman endpoint requires that you use a streaming connection.