# README
Go API client for swagger
This documentation describes the Podman v2.0 RESTful API. It replaces the Podman v1.0 API and was initially delivered along with Podman v2.0. It consists of a Docker-compatible API and a Libpod API providing support for Podman’s unique features such as pods. To start the service and keep it running for 5,000 seconds (-t 0 runs forever): podman system service -t 5000 & You can then use cURL on the socket using requests documented below. NOTE: if you install the package podman-docker, it will create a symbolic link for /var/run/docker.sock to /run/podman/podman.sock See podman-service(1) for more information. Quick Examples: 'podman info' curl --unix-socket /run/podman/podman.sock http://d/v1.0.0/libpod/info 'podman pull quay.io/containers/podman' curl -XPOST --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/images/create?fromImage=quay.io%2Fcontainers%2Fpodman' 'podman list images' curl --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/libpod/images/json' | jq
Overview
This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.
- API version: 0.0.1
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://podman.io/community/
Installation
Put the package under your project folder and add the following in import:
import "./swagger"
Documentation for API Endpoints
All URIs are relative to http://podman.io/
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ContainersApi | ChangesContainer | Get /libpod/containers/{name}/changes | Report on changes to container's filesystem; adds, deletes or modifications. |
| ContainersApi | LibpodAttachContainer | Post /libpod/containers/{name}/attach | Attach to a container |
| ContainersApi | LibpodCheckpointContainer | Post /libpod/containers/{name}/checkpoint | Checkpoint a container |
| ContainersApi | LibpodCommitContainer | Post /libpod/commit | Commit |
| ContainersApi | LibpodContainerExists | Get /libpod/containers/{name}/exists | Check if container exists |
| ContainersApi | LibpodCreateContainer | Post /libpod/containers/create | Create a container |
| ContainersApi | LibpodExportContainer | Get /libpod/containers/{name}/export | Export a container |
| ContainersApi | LibpodGenerateKube | Get /libpod/generate/{name:.*}/kube | Generate a Kubernetes YAML file. |
| ContainersApi | LibpodGenerateSystemd | Get /libpod/generate/{name:.*}/systemd | Generate Systemd Units |
| ContainersApi | LibpodGetContainer | Get /libpod/containers/{name}/json | Inspect container |
| ContainersApi | LibpodInitContainer | Post /libpod/containers/{name}/init | Initialize a container |
| ContainersApi | LibpodKillContainer | Post /libpod/containers/{name}/kill | Kill container |
| ContainersApi | LibpodListContainers | Get /libpod/containers/json | List containers |
| ContainersApi | LibpodLogsFromContainer | Get /libpod/containers/{name}/logs | Get container logs |
| ContainersApi | LibpodMountContainer | Post /libpod/containers/{name}/mount | Mount a container |
| ContainersApi | LibpodPauseContainer | Post /libpod/containers/{name}/pause | Pause a container |
| ContainersApi | LibpodPlayKube | Post /libpod/play/kube | Play a Kubernetes YAML file. |
| ContainersApi | LibpodPruneContainers | Post /libpod/containers/prune | Delete stopped containers |
| ContainersApi | LibpodPutArchive | Post /libpod/containers/{name}/copy | Copy files into a container |
| ContainersApi | LibpodRemoveContainer | Delete /libpod/containers/{name} | Delete container |
| ContainersApi | LibpodResizeContainer | Post /libpod/containers/{name}/resize | Resize a container's TTY |
| ContainersApi | LibpodRestartContainer | Post /libpod/containers/{name}/restart | Restart a container |
| ContainersApi | LibpodRestoreContainer | Post /libpod/containers/{name}/restore | Restore a container |
| ContainersApi | LibpodRunHealthCheck | Get /libpod/containers/{name:.*}/healthcheck | Run a container's healthcheck |
| ContainersApi | LibpodShowMountedContainers | Get /libpod/containers/showmounted | Show mounted containers |
| ContainersApi | LibpodStartContainer | Post /libpod/containers/{name}/start | Start a container |
| ContainersApi | LibpodStatsContainer | Get /libpod/containers/{name}/stats | Get stats for a container |
| ContainersApi | LibpodStatsContainers | Get /libpod/containers/stats | Get stats for one or more containers |
| ContainersApi | LibpodStopContainer | Post /libpod/containers/{name}/stop | Stop a container |
| ContainersApi | LibpodTopContainer | Get /libpod/containers/{name}/top | List processes |
| ContainersApi | LibpodUnmountContainer | Post /libpod/containers/{name}/unmount | Unmount a container |
| ContainersApi | LibpodUnpauseContainer | Post /libpod/containers/{name}/unpause | Unpause Container |
| ContainersApi | LibpodWaitContainer | Post /libpod/containers/{name}/wait | Wait on a container |
| ContainersCompatApi | AttachContainer | Post /containers/{name}/attach | Attach to a container |
| ContainersCompatApi | ChangesContainer | Get /libpod/containers/{name}/changes | Report on changes to container's filesystem; adds, deletes or modifications. |
| ContainersCompatApi | CommitContainer | Post /commit | New Image |
| ContainersCompatApi | CreateContainer | Post /containers/create | Create a container |
| ContainersCompatApi | ExportContainer | Get /containers/{name}/export | Export a container |
| ContainersCompatApi | GetArchive | Get /containers/{name}/archive | Get files from a container |
| ContainersCompatApi | GetContainer | Get /containers/{name}/json | Inspect container |
| ContainersCompatApi | KillContainer | Post /containers/{name}/kill | Kill container |
| ContainersCompatApi | LibpodGetArchive | Get /libpod/containers/{name}/copy | Copy files from a container |
| ContainersCompatApi | ListContainers | Get /containers/json | List containers |
| ContainersCompatApi | LogsFromContainer | Get /containers/{name}/logs | Get container logs |
| ContainersCompatApi | PauseContainer | Post /containers/{name}/pause | Pause container |
| ContainersCompatApi | PruneContainers | Post /containers/prune | Delete stopped containers |
| ContainersCompatApi | PutArchive | Put /containers/{name}/archive | Put files into a container |
| ContainersCompatApi | RemoveContainer | Delete /containers/{name} | Remove a container |
| ContainersCompatApi | ResizeContainer | Post /containers/{name}/resize | Resize a container's TTY |
| ContainersCompatApi | RestartContainer | Post /containers/{name}/restart | Restart container |
| ContainersCompatApi | StartContainer | Post /containers/{name}/start | Start a container |
| ContainersCompatApi | StatsContainer | Get /containers/{name}/stats | Get stats for a container |
| ContainersCompatApi | StopContainer | Post /containers/{name}/stop | Stop a container |
| ContainersCompatApi | TopContainer | Get /containers/{name}/top | List processes running inside a container |
| ContainersCompatApi | UnpauseContainer | Post /containers/{name}/unpause | Unpause container |
| ContainersCompatApi | WaitContainer | Post /containers/{name}/wait | Wait on a container |
| ExecApi | LibpodCreateExec | Post /libpod/containers/{name}/exec | Create an exec instance |
| ExecApi | LibpodInspectExec | Get /libpod/exec/{id}/json | Inspect an exec instance |
| ExecApi | LibpodResizeExec | Post /libpod/exec/{id}/resize | Resize an exec instance |
| ExecApi | LibpodStartExec | Post /libpod/exec/{id}/start | Start an exec instance |
| ExecCompatApi | CreateExec | Post /containers/{name}/exec | Create an exec instance |
| ExecCompatApi | InspectExec | Get /exec/{id}/json | Inspect an exec instance |
| ExecCompatApi | ResizeExec | Post /exec/{id}/resize | Resize an exec instance |
| ExecCompatApi | StartExec | Post /exec/{id}/start | Start an exec instance |
| ImagesApi | LibpodBuildImage | Post /libpod/build | Create image |
| ImagesApi | LibpodChangesImages | Get /libpod/images/{name}/changes | Report on changes to images's filesystem; adds, deletes or modifications. |
| ImagesApi | LibpodExportImage | Get /libpod/images/{name:.*}/get | Export an image |
| ImagesApi | LibpodExportImages | Get /libpod/images/export | Export multiple images |
| ImagesApi | LibpodImageExists | Get /libpod/images/{name:.*}/exists | Image exists |
| ImagesApi | LibpodImageHistory | Get /libpod/images/{name:.*}/history | History of an image |
| ImagesApi | LibpodImageTree | Get /libpod/images/{name:.*}/tree | Image tree |
| ImagesApi | LibpodImagesImport | Post /libpod/images/import | Import image |
| ImagesApi | LibpodImagesLoad | Post /libpod/images/load | Load image |
| ImagesApi | LibpodImagesPull | Post /libpod/images/pull | Pull images |
| ImagesApi | LibpodImagesRemove | Delete /libpod/images/remove | Remove one or more images from the storage. |
| ImagesApi | LibpodInspectImage | Get /libpod/images/{name:.*}/json | Inspect an image |
| ImagesApi | LibpodListImages | Get /libpod/images/json | List Images |
| ImagesApi | LibpodPruneImages | Post /libpod/images/prune | Prune unused images |
| ImagesApi | LibpodPushImage | Post /libpod/images/{name:.*}/push | Push Image |
| ImagesApi | LibpodRemoveImage | Delete /libpod/images/{name:.*} | Remove an image from the local storage. |
| ImagesApi | LibpodSearchImages | Get /libpod/images/search | Search images |
| ImagesApi | LibpodTagImage | Post /libpod/images/{name:.*}/tag | Tag an image |
| ImagesApi | LibpodUntagImage | Post /libpod/images/{name:.*}/untag | Untag an image |
| ImagesCompatApi | BuildImage | Post /build | Create image |
| ImagesCompatApi | CreateImage | Post /images/create | Create an image |
| ImagesCompatApi | ExportImage | Get /images/{name:.*}/get | Export an image |
| ImagesCompatApi | ImageHistory | Get /images/{name:.*}/history | History of an image |
| ImagesCompatApi | ImportImage | Post /images/load | Import image |
| ImagesCompatApi | InspectImage | Get /images/{name:.*}/json | Inspect an image |
| ImagesCompatApi | ListImages | Get /images/json | List Images |
| ImagesCompatApi | PruneImages | Post /images/prune | Prune unused images |
| ImagesCompatApi | PushImage | Post /images/{name:.*}/push | Push Image |
| ImagesCompatApi | RemoveImage | Delete /images/{name:.*} | Remove Image |
| ImagesCompatApi | SearchImages | Get /images/search | Search images |
| ImagesCompatApi | TagImage | Post /images/{name:.*}/tag | Tag an image |
| ManifestsApi | AddManifest | Post /libpod/manifests/{name:.*}/add | |
| ManifestsApi | Create | Post /libpod/manifests/create | Create |
| ManifestsApi | Inspect | Get /libpod/manifests/{name:.*}/json | Inspect |
| ManifestsApi | PushManifest | Post /libpod/manifests/{name}/push | Push |
| ManifestsApi | RemoveManifest | Delete /libpod/manifests/{name:.*} | Remove |
| NetworksApi | LibpodCreateNetwork | Post /libpod/networks/create | Create network |
| NetworksApi | LibpodInspectNetwork | Get /libpod/networks/{name}/json | Inspect a network |
| NetworksApi | LibpodListNetwork | Get /libpod/networks/json | List networks |
| NetworksApi | LibpodRemoveNetwork | Delete /libpod/networks/{name} | Remove a network |
| NetworksCompatApi | CompatCreateNetwork | Post /networks/create | Create network |
| NetworksCompatApi | CompatInspectNetwork | Get /networks/{name} | Inspect a network |
| NetworksCompatApi | CompatListNetwork | Get /networks | List networks |
| NetworksCompatApi | CompatRemoveNetwork | Delete /networks/{name} | Remove a network |
| PodsApi | CreatePod | Post /libpod/pods/create | Create a pod |
| PodsApi | InspectPod | Get /libpod/pods/{name}/json | Inspect pod |
| PodsApi | KillPod | Post /libpod/pods/{name}/kill | Kill a pod |
| PodsApi | LibpodGenerateKube | Get /libpod/generate/{name:.*}/kube | Generate a Kubernetes YAML file. |
| PodsApi | LibpodGenerateSystemd | Get /libpod/generate/{name:.*}/systemd | Generate Systemd Units |
| PodsApi | LibpodPlayKube | Post /libpod/play/kube | Play a Kubernetes YAML file. |
| PodsApi | ListPods | Get /libpod/pods/json | List pods |
| PodsApi | PausePod | Post /libpod/pods/{name}/pause | Pause a pod |
| PodsApi | PodExists | Get /libpod/pods/{name}/exists | Pod exists |
| PodsApi | PrunePods | Post /libpod/pods/prune | Prune unused pods |
| PodsApi | RemovePod | Delete /libpod/pods/{name} | Remove pod |
| PodsApi | RestartPod | Post /libpod/pods/{name}/restart | Restart a pod |
| PodsApi | StartPod | Post /libpod/pods/{name}/start | Start a pod |
| PodsApi | StatsPod | Get /libpod/pods/stats | Get stats for one or more pods |
| PodsApi | StopPod | Post /libpod/pods/{name}/stop | Stop a pod |
| PodsApi | TopPod | Get /libpod/pods/{name}/top | List processes |
| PodsApi | UnpausePod | Post /libpod/pods/{name}/unpause | Unpause a pod |
| SystemApi | Df | Get /libpod/system/df | Show disk usage |
| SystemApi | LibpodGetEvents | Get /libpod/events | Get events |
| SystemApi | LibpodGetInfo | Get /libpod/info | Get info |
| SystemApi | LibpodPingGet | Get /libpod/_ping | Ping service |
| SystemApi | PruneSystem | Post /libpod/system/prune | Prune unused data |
| SystemApi | SystemVersion | Get /libpod/version | Component Version information |
| SystemCompatApi | CompatSystemVersion | Get /version | Component Version information |
| SystemCompatApi | GetEvents | Get /events | Get events |
| SystemCompatApi | GetInfo | Get /info | Get info |
| SystemCompatApi | LibpodPingGet | Get /libpod/_ping | Ping service |
| VolumesApi | LibpodCreateVolume | Post /libpod/volumes/create | Create a volume |
| VolumesApi | LibpodInspectVolume | Get /libpod/volumes/{name}/json | Inspect volume |
| VolumesApi | LibpodListVolumes | Get /libpod/volumes/json | List volumes |
| VolumesApi | LibpodPruneVolumes | Post /libpod/volumes/prune | Prune volumes |
| VolumesApi | LibpodRemoveVolume | Delete /libpod/volumes/{name} | Remove volume |
| VolumesCompatApi | CreateVolume | Post /volumes/create | Create a volume |
| VolumesCompatApi | InspectVolume | Get /volumes/{name} | Inspect volume |
| VolumesCompatApi | ListVolumes | Get /volumes | List volumes |
| VolumesCompatApi | PruneVolumes | Post /volumes/prune | Prune volumes |
| VolumesCompatApi | RemoveVolume | Delete /volumes/{name} | Remove volume |
Documentation For Models
- Address
- AuthenticateOkBody
- AutoUserNsOptions
- Body
- Body1
- Body10
- Body11
- Body2
- Body3
- Body4
- Body5
- Body6
- Body7
- Body8
- Body9
- CgroupConfig
- Change
- Config
- ConfigReference
- ConmonInfo
- ContainerBasicConfig
- ContainerCgroupConfig
- ContainerChangeResponseItem
- ContainerCreateCreatedBody
- ContainerHealthCheckConfig
- ContainerNamedVolume
- ContainerNetworkConfig
- ContainerNode
- ContainerResourceConfig
- ContainerSecurityConfig
- ContainerSize
- ContainerState
- ContainerStorageConfig
- ContainerStore
- ContainerTopOkBody
- ContainerUpdateOkBody
- ContainerWaitOkBody
- ContainerWaitOkBodyError
- ContainersPruneReport
- CreateConfig
- CreateResourceConfig
- Data
- DeviceMapping
- DeviceRequest
- DistributionInfo
- DockerVolumeCreate
- EndpointIpamConfig
- EndpointResource
- EndpointSettings
- ErrorResponse
- GraphDriverData
- Health
- HealthCheckLog
- HealthCheckResults
- HealthConfig
- HealthcheckResult
- History
- HistoryResponseItem
- HostConfig
- HostInfo
- IdMap
- IdMappingOptions
- IdMappings
- IdResponse
- ImageConfig
- ImageDeleteResponse
- ImageDeleteResponseItem
- ImageImportReport
- ImageLayer
- ImageLoadReport
- ImageMetadata
- ImageStore
- ImageSummary
- Info
- InlineResponse200
- InlineResponse2001
- InlineResponse20010
- InlineResponse20011
- InlineResponse20012
- InlineResponse20013
- InlineResponse20014
- InlineResponse20015
- InlineResponse20016
- InlineResponse20017
- InlineResponse20018
- InlineResponse20019
- InlineResponse2002
- InlineResponse2003
- InlineResponse2003Error
- InlineResponse2004
- InlineResponse2005
- InlineResponse2006
- InlineResponse2007
- InlineResponse2008
- InlineResponse2009
- InlineResponse201
- InlineResponse400
- InspectAdditionalNetwork
- InspectBlkioThrottleDevice
- InspectBlkioWeightDevice
- InspectContainerConfig
- InspectContainerHostConfig
- InspectContainerState
- InspectDevice
- InspectHostPort
- InspectLogConfig
- InspectMount
- InspectNetworkSettings
- InspectPodContainerInfo
- InspectPodInfraConfig
- InspectRestartPolicy
- InspectUlimit
- IpNet
- Ipam
- IpamConfig
- IpcConfig
- LibpodContainersPruneReport
- LibpodImagesPullReport
- LibpodImagesRemoveReport
- LinuxBlockIo
- LinuxBlockIoDevice
- LinuxCpu
- LinuxDevice
- LinuxDeviceCgroup
- LinuxHugepageLimit
- LinuxInterfacePriority
- LinuxMemory
- LinuxNetwork
- LinuxPids
- LinuxRdma
- LinuxResources
- LinuxThrottleDevice
- LinuxWeightDevice
- List
- ListContainer
- ListContainerNamespaces
- ListPodContainer
- ListPodsReport
- ListRegistriesReport
- LogConfig
- ManifestAddOpts
- Mount
- MountPoint
- NamedVolume
- Namespace
- NetworkConfig
- NetworkCreate
- NetworkCreateOptions
- NetworkCreateReport
- NetworkCreateRequest
- NetworkListReport
- NetworkResource
- NetworkRmReport
- NetworkSettings
- OciRuntimeInfo
- OverlayVolume
- PeerInfo
- PidConfig
- PlayKubePod
- PlayKubeReport
- Plugin
- PluginConfig
- PluginConfigArgs
- PluginConfigInterface
- PluginConfigLinux
- PluginConfigNetwork
- PluginConfigRootfs
- PluginConfigUser
- PluginDevice
- PluginEnv
- PluginInterfaceType
- PluginMount
- PluginSettings
- PodBasicConfig
- PodCgroupConfig
- PodCreateConfig
- PodKillReport
- PodNetworkConfig
- PodPauseReport
- PodPruneReport
- PodRestartReport
- PodRmReport
- PodSpecGenerator
- PodStartReport
- PodStatsReport
- PodStopReport
- PodUnpauseReport
- Port
- PortBinding
- PortMapping
- PosixRlimit
- RemoteSocket
- Report
- RestartPolicy
- RootFs
- Schema2HealthConfig
- SecurityConfig
- ServiceInfo
- ServiceUpdateResponse
- SlirpInfo
- SpecGenerator
- StoreInfo
- SystemDfContainerReport
- SystemDfImageReport
- SystemDfVolumeReport
- Task
- ThrottleDevice
- Ulimit
- UserConfig
- UtsConfig
- Version
- Volume
- VolumeCreate
- VolumeCreateBody
- VolumeInfo
- VolumeListBody
- VolumeListOkBody
- VolumePruneReport
- VolumeUsageData
- WeightDevice
Documentation For Authorization
Endpoints do not require authorization.
Author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
# Structs
Address represents an IP address.
APIClient manages communication with the Provides a container compatible interface.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
AuthenticateOKBody authenticate o k body.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CgroupConfig configures the cgroup namespace for the container.
It describes changes of the files in the path respect to the parent layers.
It should hold only portable information about the container.
ConfigReference specifies the source which provides a network's configuration.
No description provided by the author
ConmonInfo describes the conmon executable being used.
No description provided by the author
ContainerCgroupConfig contains configuration information about a container's cgroups.
ContainerChangeResponseItem change item in response to ContainerChanges operation.
ContainerCreateCreatedBody OK response to ContainerCreate operation.
ContainerHealthCheckConfig describes a container healthcheck with attributes like command, retries, interval, start period, and timeout.
ContainerNamedVolume is a named volume that will be mounted into the container.
ContainerNetworkConfig contains information on a container's network configuration.
ContainerNode stores information about the node that a container is running on.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ContainerSecurityConfig is a container's security features, including SELinux, Apparmor, and Seccomp.
ContainerSize holds the size of the container's root filesystem and top read-write layer.
No description provided by the author
ContainerState stores container's running state it's part of ContainerJSONBase and will return by \"inspect\" command.
ContainerStorageConfig contains information on the storage configuration of a container.
ContainerStore describes the quantity of containers in the store by status.
ContainerTopOKBody OK response to ContainerTop operation.
ContainerUpdateOKBody OK response to ContainerUpdate operation.
ContainerWaitOKBody OK response to ContainerWait operation.
ContainerWaitOKBodyError container waiting error, if any.
CreateConfig is a pre OCI spec structure.
CreateResourceConfig represents resource elements in CreateConfig structures.
Data handles the data for a storage driver.
No description provided by the author
Used by GPU device drivers.
DistributionInfo describes the host distribution for libpod.
No description provided by the author
EndpointIPAMConfig represents IPAM configurations for the endpoint.
EndpointResource contains network resources allocated and used for a container in a network.
EndpointSettings stores the network endpoint details.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GenericSwaggerError Provides access to the body, error and model on returned errors.
No description provided by the author
Health stores information about the container's healthcheck results.
HealthCheckLog describes the results of a single healthcheck.
HealthcheckResult stores information about a single run of a healthcheck probe.
HealthCheckResults describes the results/logs from a healthcheck.
No description provided by the author
No description provided by the author
HistoryResponseItem individual image layer information in response to ImageHistory operation.
Here, \"non-portable\" means \"dependent of the host we are running on\".
HostInfo describes the libpod host.
IDMap contains a single entry for user namespace range remapping.
IDMappingOptions are used for specifying how ID mapping should be set up for a layer or container.
IDMappings describe the GID and UID mappings.
IDResponse Response to an API call that returns just an Id.
No description provided by the author
ImageDeleteResponse is the response for removing an image from storage and containers what was untagged vs actually removed.
ImageDeleteResponseItem image delete response item.
No description provided by the author
No description provided by the author
No description provided by the author
ImageMetadata contains engine-local data about the image.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ImageStore describes the image store.
ImageSummary image summary.
Info is the overall struct that describes the host system running libpod/podman.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
InspectAdditionalNetwork holds information about non-default CNI networks the container has been connected to.
InspectBlkioThrottleDevice holds information about a speed cap for a device node.
InspectBlkioWeightDevice holds information about the relative weight of an individual device node.
InspectContainerConfig holds further data about how a container was initially configured.
InspectContainerHostConfig holds information used when the container was created.
InspectContainerState provides a detailed record of a container's current state.
No description provided by the author
InspectHostPort provides information on a port on the host that a container's port is bound to.
InspectLogConfig holds information about a container's configured log driver and is presently unused.
InspectMount provides a record of a single mount in a container.
InspectNetworkSettings holds information about the network settings of the container.
No description provided by the author
InspectPodInfraConfig contains the configuration of the pod's infra container.
No description provided by the author
No description provided by the author
IPAM represents IP Address Management.
IPAMConfig represents IPAM configurations.
IpcConfig configures the ipc namespace for the container.
No description provided by the author
No description provided by the author
No description provided by the author
LibpodImagesRemoveReport is the return type for image removal via the rest api.
LinuxBlockIO for Linux cgroup 'blkio' resource management.
linuxBlockIODevice holds major:minor format supported in blkio cgroup.
LinuxCPU for Linux cgroup 'cpu' resource management.
LinuxDevice represents the mknod information for a Linux special device file.
LinuxDeviceCgroup represents a device rule for the devices specified to the device controller.
LinuxHugepageLimit structure corresponds to limiting kernel hugepages.
LinuxInterfacePriority for network interfaces.
LinuxMemory for Linux cgroup 'memory' resource management.
LinuxNetwork identification and priority configuration.
LinuxPids for Linux cgroup 'pids' resource management (Linux 4.3).
LinuxRdma for Linux cgroup 'rdma' resource management (Linux 4.11).
LinuxResources has container runtime resource constraints.
LinuxThrottleDevice struct holds a `major:minor rate_per_second` pair.
LinuxWeightDevice struct holds a `major:minor weight` pair for weightDevice.
Callers can either use this abstract interface without understanding the details of the formats, or instantiate a specific implementation (e.g.
Listcontainer describes a container suitable for listing.
ListContainer Namespaces contains the identifiers of the container's Linux namespaces.
No description provided by the author
No description provided by the author
ListRegistriesReport is the report when querying for a sorted list of registries which may be contacted during certain operations.
LogConfig describes the logging characteristics for a container.
Options for adding a manifest.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is used for reporting the mountpoints in use by a container.
NamedVolume holds information about a named volume that will be mounted into the container.
Namespace describes the namespace.
NetworkConfig configures the network namespace for the container.
NetworkCreate is the expected body of the \"create network\" http request message.
NetworkCreateOptions describes options to create a network.
NetworkCreateReport describes a created network for the cli.
No description provided by the author
NetworkListReport describes the results from listing networks.
NetworkResource is the body of the \"get network\" http response message.
NetworkRmReport describes the results of network removal.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NetworkSettings exposes the network settings in the api.
OCIRuntimeInfo describes the runtime (crun or runc) being used with podman.
OverlayVolume holds information about a overlay volume that will be mounted into the container.
PeerInfo represents one peer of an overlay network.
PidConfig configures the pid namespace for the container.
PlayKubePod represents a single pod and associated containers created by play kube.
No description provided by the author
Plugin A plugin for the Engine API.
No description provided by the author
PluginConfigArgs plugin config args.
PluginConfigInterface The interface between Docker and the plugin.
PluginConfigLinux plugin config linux.
PluginConfigNetwork plugin config network.
PluginConfigRootfs plugin config rootfs.
PluginConfigUser plugin config user.
PluginDevice plugin device.
PluginEnv plugin env.
PluginInterfaceType plugin interface type.
PluginMount plugin mount.
No description provided by the author
No description provided by the author
This will be expanded in future updates to pods.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PodSpecGenerator describes options to create a pod.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Port An open port on a container.
PortBinding represents a binding between a Host IP address and a Host Port.
No description provided by the author
POSIXRlimit type and restrictions.
RemoteSocket describes information about the API socket.
No description provided by the author
No description provided by the author
RootFS holds the root fs information of an image.
Schema2HealthConfig is a HealthConfig, which holds configuration settings for the HEALTHCHECK feature, from docker/docker/api/types/container.
SecurityConfig configures the security features for the container.
ServiceInfo represents service parameters with the list of service's tasks.
ServiceUpdateResponse service update response.
SlirpInfo describes the slirp executable that is being being used.
SpecGenerator creates an OCI spec and Libpod configuration options to create a container based on the given configuration.
StoreInfo describes the container storage and its attributes.
No description provided by the author
No description provided by the author
SystemDfContainerReport describes a container for use with df.
SystemDfImageReport describes an image for use with df.
SystemDfVolumeReport describes a volume and its size.
Task carries the information about one backend task.
ThrottleDevice is a structure that holds device:rate_per_second pair.
No description provided by the author
UserConfig configures the user namespace for the container.
UtsConfig configures the uts namespace for the container.
Version is an output struct for API.
Volume volume.
No description provided by the author
VolumeCreateBody Volume configuration.
VolumeInfo Volume list response.
VolumeListBody Volume list response.
VolumeListOKBody Volume list response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
VolumeUsageData Usage details about the volume.
WeightDevice is a structure that holds device:weight pair.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author