Podman containers API is one of 18 APIs that Podman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Containers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.
This API exposes
37 operations
across 36 paths,
and defines 80 schemas.
It is described by OpenAPI 3.2.0, at version 5.0.0.
Requests are made against 2 base URLs: http://podman.io/, https://podman.io/.
The identity and technical contract details declared by the specification.
UpdateEntities
object
UpdateEntities used to wrap the oci resource spec in a swagger model
32 properties
LinuxThrottleDevice
object
LinuxThrottleDevice struct holds a major:minor ratepersecond pair
3 properties
Namespace
object
Namespace describes the namespace
2 properties
InspectBlkioThrottleDevice
object
InspectBlkioThrottleDevice holds information about a speed cap for a device node. This cap applies to a specific operation (read, write, etc) on the given node.
2 properties
LinuxInterfacePriority
object
LinuxInterfacePriority for network interfaces
2 properties
ContainersPruneReportLibpod
object
3 properties
AutoUserNsOptions
object
6 properties
TmpfsOptions
object
3 properties
WeightDevice
object
WeightDevice is a structure that holds device:weight pair
2 properties
ArtifactVolume
object
ArtifactVolume is a volume based on a artifact. The artifact blobs will be bind mounted directly as files and must always be read only.
5 properties
InspectUlimit
object
3 properties
InspectAdditionalNetwork
object
InspectAdditionalNetwork holds information about non-default networks the container has been connected to. As with InspectNetworkSettings, many fields are unus…
16 properties
ThrottleDevice
object
ThrottleDevice is a structure that holds device:ratepersecond pair
2 properties
LinuxRdma
object
LinuxRdma for Linux cgroup 'rdma' resource management (Linux 4.11)
2 properties
ContainerStats
object
ContainerStats contains the statistics information for a running container
16 properties
LinuxDeviceCgroup
object
LinuxDeviceCgroup represents a device rule for the devices specified to the device controller
5 properties
LinuxMemory
object
LinuxMemory for Linux cgroup 'memory' resource management
9 properties
InspectHostPort
object
InspectHostPort provides information on a port on the host that a container's port is bound to.
2 properties
POSIXRlimit
object
POSIXRlimit type and restrictions
3 properties
LibpodContainersRmReport
object
2 properties
InspectDevice
object
3 properties
IDMappingOptions
object
IDMappingOptions are used for specifying how ID mapping should be set up for a layer or container.
6 properties
LinuxWeightDevice
object
LinuxWeightDevice struct holds a major:minor weight pair for weightDevice
4 properties
LinuxDevice
object
LinuxDevice represents the mknod information for a Linux special device file
7 properties
ContainerTopOKBody
object
2 properties
OverlayVolume
object
OverlayVolume holds information about an overlay volume that will be mounted into the container.
3 properties
Schema2HealthConfig
object
Schema2HealthConfig is a HealthConfig, which holds configuration settings for the HEALTHCHECK feature, from docker/docker/api/types/container.
6 properties
PerNetworkOptions
object
5 properties
LinuxPersonalityDomain
string
LinuxCPU
object
LinuxCPU for Linux cgroup 'cpu' resource management
9 properties
Address
object
2 properties
HealthCheckLog
object
HealthCheckLog describes the results of a single healthcheck
4 properties
InspectLogConfig
object
InspectLogConfig holds information about a container's configured log driver
5 properties
ListContainer
object
ListContainer describes a container suitable for listing
InspectContainerHostConfig
object
InspectContainerHostConfig holds information used when the container was created. It's very much a Docker-specific struct, retained (mostly) as-is for compatib…
71 properties
StartupHealthCheck
object
7 properties
InspectNetworkSettings
object
InspectNetworkSettings holds information about the network settings of the container. Many fields are maintained only for compatibility with docker inspect and…
19 properties
LogConfigLibpod
object
LogConfig describes the logging characteristics for a container
5 properties
InspectRestartPolicy
object
2 properties
NamedVolume
object
NamedVolume holds information about a named volume that will be mounted into the container.
5 properties
LinuxBlockIO
object
LinuxBlockIO for Linux cgroup 'blkio' resource management
7 properties
FileMode
integer
The bits have the same definition on all systems, so that information about files can be moved from one system to another portably. Not all bits apply to all s…
InspectSecret
object
InspectSecret contains information on secrets mounted inside the container
5 properties
LinuxResources
object
LinuxResources has container runtime resource constraints
9 properties
InspectMount
object
InspectMount provides a record of a single mount in a container. It contains fields for both named and normal volumes. Only user-specified volumes will be incl…
10 properties
LinuxPersonalityFlag
string
InspectContainerState
object
InspectContainerState provides a detailed record of a container's current state. It is returned as part of InspectContainerData. As with InspectContainerData,…
23 properties
ImageVolume
object
ImageVolume is a volume based on a container image. The container image is first mounted on the host and is then bind-mounted into the container. An ImageVolum…
4 properties
VolumeOptions
object
4 properties
DriverData
object
DriverData handles the data for a storage driver
2 properties
2 required
Mount
object
10 properties
InspectContainerData
object
InspectContainerData provides a detailed record of a container's configuration and state as viewed by Libpod. Large portions of this structure are defined such…
42 properties
InspectIDMappings
object
2 properties
LinuxHugepageLimit
object
Default to reservation limits if supported. Otherwise fallback to page fault limits.
2 properties
LinuxPids
object
LinuxPids for Linux cgroup 'pids' resource management (Linux 4.3)
1 property
ContainerCreateResponse
object
ContainerCreateResponse is the response struct for creating a container
SpecGenerator
object
SpecGenerator creates an OCI spec and Libpod configuration options to create a container based on the given configuration.
125 properties
Secret
object
5 properties
InspectBlkioWeightDevice
object
InspectBlkioWeightDevice holds information about the relative weight of an individual device node. Weights are used in the I/O scheduler to give relative prior…
2 properties
LinuxPersonality
object
LinuxPersonality represents the Linux personality syscall input
2 properties
LinuxNetwork
object
LinuxNetwork identification and priority configuration
2 properties
Driver
object
2 properties
InspectContainerConfig
object
InspectContainerConfig holds further data about how a container was initially configured.
37 properties
Duration
integer
A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to appro…
LinuxIntelRdt
object
LinuxIntelRdt has container runtime resource constraints for Intel RDT CAT and MBA features and flags enabling Intel RDT CMT and MBM features. Intel RDT featur…
5 properties
ErrorModel
object
ErrorModel is used in remote connections with podman
3 properties
Signal
integer
It implements the [os.Signal] interface.
IDMap
object
IDMap contains a single entry for user namespace range remapping. An array of IDMap entries represents the structure that will be provided to the Linux kernel…
3 properties
HealthCheckResults
object
HealthCheckResults describes the results/logs from a healthcheck
3 properties
HealthCheckOnFailureAction
integer
HealthCheckOnFailureAction defines how Podman reacts when a container's health status turns unhealthy.
ContainerNetworkStats
object
Statistics for an individual container network interface
8 properties
BindOptions
object
5 properties
ImageOptions
object
1 property
PortMapping
object
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Podman publishes across the network.
