Struct podman_rest_client::v5::APIClient

pub struct APIClient { /* private fields */ }

Implementations

impl APIClient

pub fn new<C: Connector>(config: Config<C>) -> APIClient

Trait Implementations

impl Client for APIClient

fn containers(&self) -> &dyn Containers

Actions related to containers

fn containers_compat(&self) -> &dyn ContainersCompat

Actions related to containers for the compatibility endpoints

fn exec(&self) -> &dyn Exec

Actions related to exec

fn exec_compat(&self) -> &dyn ExecCompat

Actions related to exec for the compatibility endpoints

fn images(&self) -> &dyn Images

Actions related to images

fn images_compat(&self) -> &dyn ImagesCompat

Actions related to images for the compatibility endpoints

fn manifests(&self) -> &dyn Manifests

Actions related to manifests

fn networks(&self) -> &dyn Networks

Actions related to networks

fn networks_compat(&self) -> &dyn NetworksCompat

Actions related to networks for the compatibility endpoints

fn pods(&self) -> &dyn Pods

Actions related to pods

fn secrets(&self) -> &dyn Secrets

Actions related to secrets

fn secrets_compat(&self) -> &dyn SecretsCompat

Actions related to secrets for the compatibility endpoints

fn system(&self) -> &dyn System

Actions related to Podman engine

fn system_compat(&self) -> &dyn SystemCompat

Actions related to Podman and compatibility engines

fn volumes(&self) -> &dyn Volumes

Actions related to volumes

fn volumes_compat(&self) -> &dyn VolumesCompat

Actions related to volumes for the compatibility endpoints

impl Containers for APIClient

fn image_commit_libpod<'a>( &'a self, params: Option<ImageCommitLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/commit Commit Create a new image from a container

fn container_delete_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerDeleteLibpod>, ) -> Pin<Box<dyn Future<Output = Result<Vec<LibpodContainersRmReport>, Error>> + Send + 'a>>

DELETE /libpod/containers/{name} Delete container Delete container

fn put_container_archive_libpod<'a>( &'a self, name: &'a str, params: Option<PutContainerArchiveLibpod<'a>>, request: String, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/containers/{name}/archive Copy files into a container Copy a tar archive of files into a container

fn container_attach_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerAttachLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/attach Attach to a container Attach to a container to read its output or send it input. You can attach to the same container multiple times and you can reattach to containers that have been detached.

fn container_changes_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerChangesLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/containers/{name}/changes Report on changes to container’s filesystem; adds, deletes or modifications. Returns which files in a container’s filesystem have been added, deleted, or modified. The Kind of modification can be one of:

fn container_checkpoint_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerCheckpointLibpod>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/checkpoint Checkpoint a container

fn container_exists_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/containers/{name}/exists Check if container exists Quick way to determine if a container exists by name or ID

fn container_export_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/containers/{name}/export Export a container Export the contents of a container as a tarball.

fn container_healthcheck_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<HealthCheckResults, Error>> + Send + 'a>>

GET /libpod/containers/{name}/healthcheck Run a container’s healthcheck Execute the defined healthcheck and return information about the results

fn container_init_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/init Initialize a container Performs all tasks necessary for initializing the container but does not start the container.

fn container_inspect_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerInspectLibpod>, ) -> Pin<Box<dyn Future<Output = Result<InspectContainerData, Error>> + Send + 'a>>

GET /libpod/containers/{name}/json Inspect container Return low-level information about a container.

fn container_kill_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerKillLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/kill Kill container send a signal to a container, defaults to killing the container

fn container_logs_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerLogsLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/containers/{name}/logs Get container logs Get stdout and stderr logs from a container.

fn container_mount_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

POST /libpod/containers/{name}/mount Mount a container Mount a container to the filesystem

fn container_pause_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/pause Pause a container Use the cgroups freezer to suspend all processes in a container.

fn container_rename_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerRenameLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/rename Rename an existing container Change the name of an existing container.

fn container_resize_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerResizeLibpod>, ) -> Pin<Box<dyn Future<Output = Result<Value, Error>> + Send + 'a>>

POST /libpod/containers/{name}/resize Resize a container’s TTY Resize the terminal attached to a container (for use with Attach).

fn container_restart_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerRestartLibpod>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/restart Restart a container

fn container_restore_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerRestoreLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/restore Restore a container Restore a container from a checkpoint.

fn container_start_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerStartLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/start Start a container

fn container_stats_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerStatsLibpod>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/containers/{name}/stats Get stats for a container DEPRECATED. This endpoint will be removed with the next major release. Please use /libpod/containers/stats instead.

fn container_stop_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerStopLibpod>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/stop Stop a container

fn container_top_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerTopLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<ContainerTopOkBody, Error>> + Send + 'a>>

GET /libpod/containers/{name}/top List processes List processes running inside a container

fn container_unmount_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/unmount Unmount a container Unmount a container from the filesystem

fn container_unpause_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/unpause Unpause Container

fn container_update_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerUpdateLibpod<'a>>, config: UpdateEntities, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/update Update an existing containers cgroup configuration Update an existing containers cgroup configuration.

fn container_wait_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerWaitLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<i32, Error>> + Send + 'a>>

POST /libpod/containers/{name}/wait Wait on a container Wait on a container to meet a given condition

fn container_create_libpod<'a>( &'a self, create: SpecGenerator, ) -> Pin<Box<dyn Future<Output = Result<ContainerCreateResponse, Error>> + Send + 'a>>

POST /libpod/containers/create Create a container

fn container_list_libpod<'a>( &'a self, params: Option<ContainerListLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ListContainer>, Error>> + Send + 'a>>

GET /libpod/containers/json List containers Returns a list of containers

fn container_prune_libpod<'a>( &'a self, params: Option<ContainerPruneLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ContainersPruneReportLibpod>, Error>> + Send + 'a>>

POST /libpod/containers/prune Delete stopped containers Remove containers not in use

fn container_show_mounted_libpod<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, String>, Error>> + Send + 'a>>

GET /libpod/containers/showmounted Show mounted containers Lists all mounted containers mount points

fn containers_stats_all_libpod<'a>( &'a self, params: Option<ContainersStatsAllLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<ContainerStats, Error>> + Send + 'a>>

GET /libpod/containers/stats Get stats for one or more containers Return a live stream of resource usage statistics of one or more container. If no container is specified, the statistics of all containers are returned.

fn generate_systemd_libpod<'a>( &'a self, name: &'a str, params: Option<GenerateSystemdLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, String>, Error>> + Send + 'a>>

GET /libpod/generate/{name}/systemd Generate Systemd Units Generate Systemd Units based on a pod or container.

fn generate_kube_libpod<'a>( &'a self, params: Option<GenerateKubeLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

GET /libpod/generate/kube Generate a Kubernetes YAML file. Generate Kubernetes YAML based on a pod or container.

fn kube_apply_libpod<'a>( &'a self, params: Option<KubeApplyLibpod<'a>>, request: String, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

POST /libpod/kube/apply Apply a podman workload or Kubernetes YAML file. Deploy a podman container, pod, volume, or Kubernetes yaml to a Kubernetes cluster.

fn play_kube_down_libpod<'a>( &'a self, params: Option<PlayKubeDownLibpod>, ) -> Pin<Box<dyn Future<Output = Result<PlayKubeReport, Error>> + Send + 'a>>

DELETE /libpod/play/kube Remove resources created from kube play Tears down pods, secrets, and volumes defined in a YAML file

fn play_kube_libpod<'a>( &'a self, params: Option<PlayKubeLibpod<'a>>, request: String, ) -> Pin<Box<dyn Future<Output = Result<PlayKubeReport, Error>> + Send + 'a>>

POST /libpod/play/kube Play a Kubernetes YAML file. Create and run pods based on a Kubernetes YAML file (pod or service kind).

impl ContainersCompat for APIClient

fn image_commit<'a>( &'a self, params: Option<ImageCommit<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /commit New Image Create a new image from a container

fn container_delete<'a>( &'a self, name: &'a str, params: Option<ContainerDelete>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

DELETE /containers/{name} Remove a container

fn container_archive<'a>( &'a self, name: &'a str, params: Option<ContainerArchive<'a>>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

GET /containers/{name}/archive Get files from a container Get a tar archive of files from a container

fn put_container_archive<'a>( &'a self, name: &'a str, params: Option<PutContainerArchive<'a>>, request: String, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /containers/{name}/archive Put files into a container Put a tar archive of files into a container

fn container_attach<'a>( &'a self, name: &'a str, params: Option<ContainerAttach<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /containers/{name}/attach Attach to a container Attach to a container to read its output or send it input. You can attach to the same container multiple times and you can reattach to containers that have been detached.

fn container_export<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /containers/{name}/export Export a container Export the contents of a container as a tarball.

fn container_inspect<'a>( &'a self, name: &'a str, params: Option<ContainerInspect>, ) -> Pin<Box<dyn Future<Output = Result<ContainerJson, Error>> + Send + 'a>>

GET /containers/{name}/json Inspect container Return low-level information about a container.

fn container_kill<'a>( &'a self, name: &'a str, params: Option<ContainerKill<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /containers/{name}/kill Kill container Signal to send to the container as an integer or string (e.g. SIGINT)

fn container_logs<'a>( &'a self, name: &'a str, params: Option<ContainerLogs<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /containers/{name}/logs Get container logs Get stdout and stderr logs from a container.

fn container_pause<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /containers/{name}/pause Pause container Use the cgroups freezer to suspend all processes in a container.

fn container_rename<'a>( &'a self, name: &'a str, params: Option<ContainerRename<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /containers/{name}/rename Rename an existing container Change the name of an existing container.

fn container_resize<'a>( &'a self, name: &'a str, params: Option<ContainerResize>, ) -> Pin<Box<dyn Future<Output = Result<Value, Error>> + Send + 'a>>

POST /containers/{name}/resize Resize a container’s TTY Resize the terminal attached to a container (for use with Attach).

fn container_restart<'a>( &'a self, name: &'a str, params: Option<ContainerRestart>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /containers/{name}/restart Restart container

fn container_start<'a>( &'a self, name: &'a str, params: Option<ContainerStart<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /containers/{name}/start Start a container

fn container_stats<'a>( &'a self, name: &'a str, params: Option<ContainerStats>, ) -> Pin<Box<dyn Future<Output = Result<Value, Error>> + Send + 'a>>

GET /containers/{name}/stats Get stats for a container This returns a live stream of a container’s resource usage statistics.

fn container_stop<'a>( &'a self, name: &'a str, params: Option<ContainerStop>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /containers/{name}/stop Stop a container Stop a container

fn container_top<'a>( &'a self, name: &'a str, params: Option<ContainerTop<'a>>, ) -> Pin<Box<dyn Future<Output = Result<ContainerTopOkBody, Error>> + Send + 'a>>

GET /containers/{name}/top List processes running inside a container

fn container_unpause<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /containers/{name}/unpause Unpause container Resume a paused container

fn container_update<'a>( &'a self, name: &'a str, resources: UpdateConfig, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /containers/{name}/update Update configuration of an existing container Change configuration settings for an existing container without requiring recreation.

fn container_wait<'a>( &'a self, name: &'a str, params: Option<ContainerWait<'a>>, ) -> Pin<Box<dyn Future<Output = Result<ContainerWaitResponse, Error>> + Send + 'a>>

POST /containers/{name}/wait Wait on a container Block until a container stops or given condition is met.

fn container_create<'a>( &'a self, params: Option<ContainerCreate<'a>>, body: CreateContainerConfig, ) -> Pin<Box<dyn Future<Output = Result<ContainerCreateResponse, Error>> + Send + 'a>>

POST /containers/create Create a container

fn container_list<'a>( &'a self, params: Option<ContainerList<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Container>, Error>> + Send + 'a>>

GET /containers/json List containers Returns a list of containers

fn container_prune<'a>( &'a self, params: Option<ContainerPrune<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ContainersPruneReport>, Error>> + Send + 'a>>

POST /containers/prune Delete stopped containers Remove containers not in use

fn container_archive_libpod<'a>( &'a self, name: &'a str, params: Option<ContainerArchiveLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

GET /libpod/containers/{name}/archive Copy files from a container Copy a tar archive of files from a container

impl Exec for APIClient

fn container_exec_libpod<'a>( &'a self, name: &'a str, control: ContainerExecLibpodBody, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/containers/{name}/exec Create an exec instance Create an exec session to run a command inside a running container. Exec sessions will be automatically removed 5 minutes after they exit.

fn exec_inspect_libpod<'a>( &'a self, id: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/exec/{id}/json Inspect an exec instance Return low-level information about an exec instance.

fn exec_resize_libpod<'a>( &'a self, id: &'a str, params: Option<ExecResizeLibpod>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/exec/{id}/resize Resize an exec instance Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.

fn exec_start_libpod<'a>( &'a self, id: &'a str, control: ExecStartLibpodBody, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/exec/{id}/start Start an exec instance Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command. The stream format is the same as the attach endpoint.

impl ExecCompat for APIClient

fn container_exec<'a>( &'a self, name: &'a str, control: ContainerExecBody, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /containers/{name}/exec Create an exec instance Create an exec session to run a command inside a running container. Exec sessions will be automatically removed 5 minutes after they exit.

fn exec_inspect<'a>( &'a self, id: &'a str, ) -> Pin<Box<dyn Future<Output = Result<InspectExecSession, Error>> + Send + 'a>>

GET /exec/{id}/json Inspect an exec instance Return low-level information about an exec instance.

fn exec_resize<'a>( &'a self, id: &'a str, params: Option<ExecResize>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /exec/{id}/resize Resize an exec instance Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.

fn exec_start<'a>( &'a self, id: &'a str, control: ExecStartBody, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /exec/{id}/start Start an exec instance Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.

impl HasConfig for APIClient

fn get_config(&self) -> &dyn ClientConfig

impl Images for APIClient

fn image_build_libpod<'a>( &'a self, params: Option<ImageBuildLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<ImageBuildLibpod200, Error>> + Send + 'a>>

POST /libpod/build Create image Build an image from the given Dockerfile(s)

fn image_delete_libpod<'a>( &'a self, name: &'a str, params: Option<ImageDeleteLibpod>, ) -> Pin<Box<dyn Future<Output = Result<LibpodImagesRemoveReport, Error>> + Send + 'a>>

DELETE /libpod/images/{name} Remove an image from the local storage. Remove an image from the local storage.

fn image_changes_libpod<'a>( &'a self, name: &'a str, params: Option<ImageChangesLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/images/{name}/changes Report on changes to images’s filesystem; adds, deletes or modifications. Returns which files in an image’s filesystem have been added, deleted, or modified. The Kind of modification can be one of:

fn image_exists_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/images/{name}/exists Image exists Check if image exists in local store

fn image_get_libpod<'a>( &'a self, name: &'a str, params: Option<ImageGetLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

GET /libpod/images/{name}/get Export an image Export an image

fn image_history_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<HistoryResponse, Error>> + Send + 'a>>

GET /libpod/images/{name}/history History of an image Return parent layers of an image.

fn image_inspect_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<ImageData, Error>> + Send + 'a>>

GET /libpod/images/{name}/json Inspect an image Obtain low-level information about an image

fn image_push_libpod<'a>( &'a self, name: &'a str, params: Option<ImagePushLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

POST /libpod/images/{name}/push Push Image Push an image to a container registry

fn image_resolve_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/images/{name}/resolve Resolve an image (short) name Resolve the passed image name to a list of fully-qualified images referring to container registries.

fn image_tag_libpod<'a>( &'a self, name: &'a str, params: Option<ImageTagLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/images/{name}/tag Tag an image Tag an image so that it becomes part of a repository.

fn image_tree_libpod<'a>( &'a self, name: &'a str, params: Option<ImageTreeLibpod>, ) -> Pin<Box<dyn Future<Output = Result<ImageTreeReport, Error>> + Send + 'a>>

GET /libpod/images/{name}/tree Image tree Retrieve the image tree for the provided image name or ID

fn image_untag_libpod<'a>( &'a self, name: &'a str, params: Option<ImageUntagLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/images/{name}/untag Untag an image Untag an image. If not repo and tag are specified, all tags are removed from the image.

fn image_export_libpod<'a>( &'a self, params: Option<ImageExportLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

GET /libpod/images/export Export multiple images Export multiple images into a single object. Only docker-archive is currently supported.

fn image_import_libpod<'a>( &'a self, params: Option<ImageImportLibpod<'a>>, upload: String, ) -> Pin<Box<dyn Future<Output = Result<ImageImportReport, Error>> + Send + 'a>>

POST /libpod/images/import Import image Import a previously exported tarball as an image.

fn image_list_libpod<'a>( &'a self, params: Option<ImageListLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<LibpodImageSummary>, Error>> + Send + 'a>>

GET /libpod/images/json List Images Returns a list of images on the server

fn image_load_libpod<'a>( &'a self, upload: String, ) -> Pin<Box<dyn Future<Output = Result<ImageLoadReport, Error>> + Send + 'a>>

POST /libpod/images/load Load image Load an image (oci-archive or docker-archive) stream.

fn image_prune_libpod<'a>( &'a self, params: Option<ImagePruneLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<PruneReport>, Error>> + Send + 'a>>

POST /libpod/images/prune Prune unused images Remove images that are not being used by a container

fn image_pull_libpod<'a>( &'a self, params: Option<ImagePullLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<LibpodImagesPullReport, Error>> + Send + 'a>>

POST /libpod/images/pull Pull images Pull one or more images from a container registry.

fn image_delete_all_libpod<'a>( &'a self, params: Option<ImageDeleteAllLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<LibpodImagesRemoveReport, Error>> + Send + 'a>>

DELETE /libpod/images/remove Remove one or more images from the storage. Remove one or more images from the storage.

fn image_scp_libpod<'a>( &'a self, name: &'a str, params: Option<ImageScpLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<ScpReport, Error>> + Send + 'a>>

POST /libpod/images/scp/{name} Copy an image from one host to another Copy an image from one host to another

fn image_search_libpod<'a>( &'a self, params: Option<ImageSearchLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<RegistrySearchResponse, Error>> + Send + 'a>>

GET /libpod/images/search Search images Search registries for images

impl ImagesCompat for APIClient

fn image_build<'a>( &'a self, params: Option<ImageBuild<'a>>, input_stream: String, ) -> Pin<Box<dyn Future<Output = Result<ImageBuild200, Error>> + Send + 'a>>

POST /build Create image Build an image from the given Dockerfile(s)

fn image_delete<'a>( &'a self, name: &'a str, params: Option<ImageDelete>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ImageDeleteResponseItems>, Error>> + Send + 'a>>

DELETE /images/{name} Remove Image Delete an image from local storage

fn image_get<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

GET /images/{name}/get Export an image Export an image in tarball format

fn image_history<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<HistoryResponse, Error>> + Send + 'a>>

GET /images/{name}/history History of an image Return parent layers of an image.

fn image_inspect<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<ImageInspect, Error>> + Send + 'a>>

GET /images/{name}/json Inspect an image Return low-level information about an image.

fn image_push<'a>( &'a self, name: &'a str, params: Option<ImagePush<'a>>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

POST /images/{name}/push Push Image Push an image to a container registry

fn image_tag<'a>( &'a self, name: &'a str, params: Option<ImageTag<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /images/{name}/tag Tag an image Tag an image so that it becomes part of a repository.

fn image_create<'a>( &'a self, params: Option<ImageCreate<'a>>, input_image: String, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

POST /images/create Create an image Create an image by either pulling it from a registry or importing it.

fn image_get_all<'a>( &'a self, params: Option<ImageGetAll<'a>>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

GET /images/get Export several images Get a tarball containing all images and metadata for several image repositories

fn image_list<'a>( &'a self, params: Option<ImageList<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Summary>, Error>> + Send + 'a>>

GET /images/json List Images Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.

fn image_load<'a>( &'a self, params: Option<ImageLoad>, request: String, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /images/load Import image Load a set of images and tags into a repository.

fn image_prune<'a>( &'a self, params: Option<ImagePrune<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ImageDeleteResponseItems>, Error>> + Send + 'a>>

POST /images/prune Prune unused images Remove images from local storage that are not being used by a container

fn image_search<'a>( &'a self, params: Option<ImageSearch<'a>>, ) -> Pin<Box<dyn Future<Output = Result<RegistrySearchResponse, Error>> + Send + 'a>>

GET /images/search Search images Search registries for an image

impl Manifests for APIClient

fn manifest_delete_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<LibpodImagesRemoveReport, Error>> + Send + 'a>>

DELETE /libpod/manifests/{name} Delete manifest list Delete named manifest list

fn manifest_create_libpod<'a>( &'a self, name: &'a str, params: Option<ManifestCreateLibpod<'a>>, options: ManifestModifyOptions, ) -> Pin<Box<dyn Future<Output = Result<IdResponse, Error>> + Send + 'a>>

POST /libpod/manifests/{name} Create Create a manifest list

fn manifest_modify_libpod<'a>( &'a self, name: &'a str, params: Option<ManifestModifyLibpod>, options: ManifestModifyOptions, ) -> Pin<Box<dyn Future<Output = Result<ManifestModifyReport, Error>> + Send + 'a>>

GET /libpod/manifests/{name} Modify manifest list Add/Remove an image(s) to a manifest list

fn manifest_add_libpod<'a>( &'a self, name: &'a str, options: ManifestAddOptions, ) -> Pin<Box<dyn Future<Output = Result<IdResponse, Error>> + Send + 'a>>

POST /libpod/manifests/{name}/add Add image Add an image to a manifest list

fn manifest_exists_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/manifests/{name}/exists Exists Check if manifest list exists

fn manifest_inspect_libpod<'a>( &'a self, name: &'a str, params: Option<ManifestInspectLibpod>, ) -> Pin<Box<dyn Future<Output = Result<Schema2ListPublic, Error>> + Send + 'a>>

GET /libpod/manifests/{name}/json Inspect Display attributes of given manifest list

fn manifest_push_v_3_libpod<'a>( &'a self, name: &'a str, params: Option<ManifestPushV3Libpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<IdResponse, Error>> + Send + 'a>>

POST /libpod/manifests/{name}/push Push manifest to registry Push a manifest list or image index to a registry

fn manifest_push_libpod<'a>( &'a self, name: &'a str, destination: &'a str, params: Option<ManifestPushLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<IdResponse, Error>> + Send + 'a>>

POST /libpod/manifests/{name}/registry/{destination} Push manifest list to registry Push a manifest list or image index to the named registry

impl Networks for APIClient

fn network_delete_libpod<'a>( &'a self, name: &'a str, params: Option<NetworkDeleteLibpod>, ) -> Pin<Box<dyn Future<Output = Result<Vec<NetworkRmReport>, Error>> + Send + 'a>>

DELETE /libpod/networks/{name} Remove a network Remove a configured network

fn network_connect_libpod<'a>( &'a self, name: &'a str, create: NetworkConnectOptions, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/networks/{name}/connect Connect container to network Connect a container to a network.

fn network_disconnect_libpod<'a>( &'a self, name: &'a str, create: NetworkDisconnect, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/networks/{name}/disconnect Disconnect container from network Disconnect a container from a network.

fn network_exists_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/networks/{name}/exists Network exists Check if network exists

fn network_inspect_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<NetworkInspectReport, Error>> + Send + 'a>>

GET /libpod/networks/{name}/json Inspect a network Display configuration for a network.

fn network_update_libpod<'a>( &'a self, name: &'a str, update: NetworkUpdateOptions, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /libpod/networks/{name}/update Update existing podman network Update existing podman network

fn network_create_libpod<'a>( &'a self, create: NetworkCreateLibpod, ) -> Pin<Box<dyn Future<Output = Result<Network, Error>> + Send + 'a>>

POST /libpod/networks/create Create network Create a new network configuration

fn network_list_libpod<'a>( &'a self, params: Option<NetworkListLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Network>, Error>> + Send + 'a>>

GET /libpod/networks/json List networks Display summary of network configurations.

fn network_prune_libpod<'a>( &'a self, params: Option<NetworkPruneLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<NetworkPruneReport>, Error>> + Send + 'a>>

POST /libpod/networks/prune Delete unused networks Remove networks that do not have containers

impl NetworksCompat for APIClient

fn network_list<'a>( &'a self, params: Option<NetworkList<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<NetworkResource>, Error>> + Send + 'a>>

GET /networks List networks Display summary of network configurations

fn network_delete<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

DELETE /networks/{name} Remove a network Remove a network

fn network_inspect<'a>( &'a self, name: &'a str, params: Option<NetworkInspect<'a>>, ) -> Pin<Box<dyn Future<Output = Result<NetworkResource, Error>> + Send + 'a>>

GET /networks/{name} Inspect a network Display low level configuration network

fn network_connect<'a>( &'a self, name: &'a str, create: NetworkConnect, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /networks/{name}/connect Connect container to network Connect a container to a network

fn network_disconnect<'a>( &'a self, name: &'a str, create: NetworkDisconnect, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

POST /networks/{name}/disconnect Disconnect container from network Disconnect a container from a network

fn network_create<'a>( &'a self, create: NetworkCreateRequest, ) -> Pin<Box<dyn Future<Output = Result<NetworkCreate201, Error>> + Send + 'a>>

POST /networks/create Create network Create a network configuration

fn network_prune<'a>( &'a self, params: Option<NetworkPrune<'a>>, ) -> Pin<Box<dyn Future<Output = Result<NetworkPrune200, Error>> + Send + 'a>>

POST /networks/prune Delete unused networks Remove networks that do not have containers

impl Pods for APIClient

fn pod_delete_libpod<'a>( &'a self, name: &'a str, params: Option<PodDeleteLibpod>, ) -> Pin<Box<dyn Future<Output = Result<PodRmReport, Error>> + Send + 'a>>

DELETE /libpod/pods/{name} Remove pod

fn pod_exists_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/pods/{name}/exists Pod exists Check if a pod exists by name or ID

fn pod_inspect_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<InspectPodData, Error>> + Send + 'a>>

GET /libpod/pods/{name}/json Inspect pod

fn pod_kill_libpod<'a>( &'a self, name: &'a str, params: Option<PodKillLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<PodKillReport, Error>> + Send + 'a>>

POST /libpod/pods/{name}/kill Kill a pod

fn pod_pause_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<PodPauseReport, Error>> + Send + 'a>>

POST /libpod/pods/{name}/pause Pause a pod Pause a pod

fn pod_restart_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<PodRestartReport, Error>> + Send + 'a>>

POST /libpod/pods/{name}/restart Restart a pod

fn pod_start_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<PodStartReport, Error>> + Send + 'a>>

POST /libpod/pods/{name}/start Start a pod

fn pod_stop_libpod<'a>( &'a self, name: &'a str, params: Option<PodStopLibpod>, ) -> Pin<Box<dyn Future<Output = Result<PodStopReport, Error>> + Send + 'a>>

POST /libpod/pods/{name}/stop Stop a pod

fn pod_top_libpod<'a>( &'a self, name: &'a str, params: Option<PodTopLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<PodTopOkBody, Error>> + Send + 'a>>

GET /libpod/pods/{name}/top List processes List processes running inside a pod

fn pod_unpause_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<PodUnpauseReport, Error>> + Send + 'a>>

POST /libpod/pods/{name}/unpause Unpause a pod

fn pod_create_libpod<'a>( &'a self, create: PodSpecGenerator, ) -> Pin<Box<dyn Future<Output = Result<IdResponse, Error>> + Send + 'a>>

POST /libpod/pods/create Create a pod

fn pod_list_libpod<'a>( &'a self, params: Option<PodListLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ListPodsReport>, Error>> + Send + 'a>>

GET /libpod/pods/json List pods

fn pod_prune_libpod<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<PodPruneReport, Error>> + Send + 'a>>

POST /libpod/pods/prune Prune unused pods

fn pod_stats_all_libpod<'a>( &'a self, params: Option<PodStatsAllLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<PodStatsReport>, Error>> + Send + 'a>>

GET /libpod/pods/stats Statistics for one or more pods Display a live stream of resource usage statistics for the containers in one or more pods

impl Secrets for APIClient

fn secret_delete_libpod<'a>( &'a self, name: &'a str, params: Option<SecretDeleteLibpod>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

DELETE /libpod/secrets/{name} Remove secret

fn secret_exists_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/secrets/{name}/exists Secret exists

fn secret_inspect_libpod<'a>( &'a self, name: &'a str, params: Option<SecretInspectLibpod>, ) -> Pin<Box<dyn Future<Output = Result<SecretInfoReport, Error>> + Send + 'a>>

GET /libpod/secrets/{name}/json Inspect secret

fn secret_create_libpod<'a>( &'a self, params: Option<SecretCreateLibpod<'a>>, request: String, ) -> Pin<Box<dyn Future<Output = Result<SecretCreateResponse, Error>> + Send + 'a>>

POST /libpod/secrets/create Create a secret

fn secret_list_libpod<'a>( &'a self, params: Option<SecretListLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<SecretInfoReport>, Error>> + Send + 'a>>

GET /libpod/secrets/json List secrets Returns a list of secrets

impl SecretsCompat for APIClient

fn secret_list<'a>( &'a self, params: Option<SecretList<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<SecretInfoReportCompat>, Error>> + Send + 'a>>

GET /secrets List secrets Returns a list of secrets

fn secret_delete<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

DELETE /secrets/{name} Remove secret

fn secret_inspect<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<SecretInfoReportCompat, Error>> + Send + 'a>>

GET /secrets/{name} Inspect secret

fn secret_create<'a>( &'a self, create: SecretCreate, ) -> Pin<Box<dyn Future<Output = Result<SecretCreateResponse, Error>> + Send + 'a>>

POST /secrets/create Create a secret

impl System for APIClient

fn system_events_libpod<'a>( &'a self, params: Option<SystemEventsLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/events Get events Returns events filtered on query parameters

fn system_info_libpod<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<LibpodInfo, Error>> + Send + 'a>>

GET /libpod/info Get info Returns information on the system and libpod configuration

fn system_data_usage_libpod<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<SystemDfReport, Error>> + Send + 'a>>

GET /libpod/system/df Show disk usage Return information about disk usage for containers, images, and volumes

fn system_prune_libpod<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<SystemPruneReport, Error>> + Send + 'a>>

POST /libpod/system/prune Prune unused data

fn system_version_libpod<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<SystemComponentVersion, Error>> + Send + 'a>>

GET /libpod/version Component Version information

impl SystemCompat for APIClient

fn system_auth<'a>( &'a self, auth_config: AuthConfig, ) -> Pin<Box<dyn Future<Output = Result<AuthReport, Error>> + Send + 'a>>

POST /auth Check auth configuration

fn system_events<'a>( &'a self, params: Option<SystemEvents<'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /events Get events Returns events filtered on query parameters

fn system_info<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /info Get info Returns information on the system and libpod configuration

fn system_ping<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'a>>

GET /libpod/_ping Ping service Return protocol information in response headers. HEAD /libpod/_ping is also supported. /_ping is available for compatibility with other engines. The ‘_ping’ endpoints are not versioned.

fn system_data_usage<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<SystemDfReport, Error>> + Send + 'a>>

GET /system/df Show disk usage Return information about disk usage for containers, images, and volumes

fn system_version<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<SystemComponentVersion, Error>> + Send + 'a>>

GET /version Component Version information

impl Volumes for APIClient

fn volume_delete_libpod<'a>( &'a self, name: &'a str, params: Option<VolumeDeleteLibpod>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

DELETE /libpod/volumes/{name} Remove volume

fn volume_exists_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

GET /libpod/volumes/{name}/exists Volume exists Check if a volume exists

fn volume_inspect_libpod<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<VolumeConfigResponse, Error>> + Send + 'a>>

GET /libpod/volumes/{name}/json Inspect volume

fn volume_create_libpod<'a>( &'a self, create: VolumeCreateOptions, ) -> Pin<Box<dyn Future<Output = Result<VolumeConfigResponse, Error>> + Send + 'a>>

POST /libpod/volumes/create Create a volume

fn volume_list_libpod<'a>( &'a self, params: Option<VolumeListLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<VolumeConfigResponse>, Error>> + Send + 'a>>

GET /libpod/volumes/json List volumes Returns a list of volumes

fn volume_prune_libpod<'a>( &'a self, params: Option<VolumePruneLibpod<'a>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<PruneReport>, Error>> + Send + 'a>>

POST /libpod/volumes/prune Prune volumes

impl VolumesCompat for APIClient

fn volume_list<'a>( &'a self, params: Option<VolumeList<'a>>, ) -> Pin<Box<dyn Future<Output = Result<ListResponse, Error>> + Send + 'a>>

GET /volumes List volumes Returns a list of volume

fn volume_delete<'a>( &'a self, name: &'a str, params: Option<VolumeDelete>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

DELETE /volumes/{name} Remove volume

fn volume_inspect<'a>( &'a self, name: &'a str, ) -> Pin<Box<dyn Future<Output = Result<Volume, Error>> + Send + 'a>>

GET /volumes/{name} Inspect volume

fn volume_create<'a>( &'a self, create: VolumeCreate, ) -> Pin<Box<dyn Future<Output = Result<Volume, Error>> + Send + 'a>>

POST /volumes/create Create a volume

fn volume_prune<'a>( &'a self, params: Option<VolumePrune<'a>>, ) -> Pin<Box<dyn Future<Output = Result<VolumesPruneReport, Error>> + Send + 'a>>

POST /volumes/prune Prune volumes