How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Podman pods API

Actions related to pods

Podman pods API is one of 18 APIs that Podman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pods. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 19 operations across 18 paths, and defines 56 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/.

19 operations 18 paths 56 schemas 2 DELETE7 GET10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.0.0
Base URL
http://d/v6.0.0/libpod
Contact
License
Terms of Service
Resource Areas
1

Paths & Operations 19

Across 18 paths, the API surfaces 19 operations — 2 DELETE, 7 GET, 10 POST. Each is listed below with its method, path, parameters, and response codes.

pods 19

Actions related to pods

GET
/libpod/generate/{name}/systemd
Generate Systemd Units
GenerateSystemdLibpod 16 params → 200500
GET
/libpod/generate/kube
Generate a Kubernetes YAML file.
GenerateKubeLibpod 6 params → 200500
POST
/libpod/kube/apply
Apply a podman workload or Kubernetes YAML file.
KubeApplyLibpod 5 params body → 200500
DELETE
/libpod/play/kube
Remove resources created from kube play
PlayKubeDownLibpod 1 param → 200500
POST
/libpod/play/kube
Play a Kubernetes YAML file.
PlayKubeLibpod 18 params body → 200500
DELETE
/libpod/pods/{name}
Remove pod
PodDeleteLibpod 3 params → 200400404500
GET
/libpod/pods/{name}/exists
Pod exists
PodExistsLibpod 1 param → 204404500
GET
/libpod/pods/{name}/json
Inspect pod
PodInspectLibpod 1 param → 200404500
POST
/libpod/pods/{name}/kill
Kill a pod
PodKillLibpod 2 params → 200400404409500
POST
/libpod/pods/{name}/pause
Pause a pod
PodPauseLibpod 1 param → 200404409500
POST
/libpod/pods/{name}/restart
Restart a pod
PodRestartLibpod 1 param → 200404409500
POST
/libpod/pods/{name}/start
Start a pod
PodStartLibpod 1 param → 200304404409500
POST
/libpod/pods/{name}/stop
Stop a pod
PodStopLibpod 2 params → 200304400404409500
GET
/libpod/pods/{name}/top
List processes
PodTopLibpod 4 params → 200404500
POST
/libpod/pods/{name}/unpause
Unpause a pod
PodUnpauseLibpod 1 param → 200404409500
POST
/libpod/pods/create
Create a pod
PodCreateLibpod body → 201400409500
GET
/libpod/pods/json
List pods
PodListLibpod 1 param → 200400500
POST
/libpod/pods/prune
Prune unused pods
PodPruneLibpod → 200400409500
GET
/libpod/pods/stats
Statistics for one or more pods
PodStatsAllLibpod 4 params → 200404500

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are PodSpecGenerator (44 properties), InspectPodData (35 properties), InspectPodInfraConfig (20 properties), Mount (10 properties). Each schema is shown below with its type and property counts.

NamedVolume
object
NamedVolume holds information about a named volume that will be mounted into the container.
5 properties
LinuxMemory
object
LinuxMemory for Linux cgroup 'memory' resource management
9 properties
LinuxBlockIO
object
LinuxBlockIO for Linux cgroup 'blkio' resource management
7 properties
LinuxThrottleDevice
object
LinuxThrottleDevice struct holds a major:minor ratepersecond pair
3 properties
ClusterOptions
object
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…
Namespace
object
Namespace describes the namespace
2 properties
Propagation
string
Consistency
string
InspectHostPort
object
InspectHostPort provides information on a port on the host that a container's port is bound to.
2 properties
PodStartReport
object
PodStopReport
object
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
PodKillReport
object
InspectDevice
object
3 properties
PodUnpauseReport
object
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
InspectPodContainerInfo
object
3 properties
LinuxWeightDevice
object
LinuxWeightDevice struct holds a major:minor weight pair for weightDevice
4 properties
IDMappingOptions
object
IDMappingOptions are used for specifying how ID mapping should be set up for a layer or container.
6 properties
LinuxNetwork
object
LinuxNetwork identification and priority configuration
2 properties
Driver
object
2 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
PodTopOKBody
object
2 properties
LinuxInterfacePriority
object
LinuxInterfacePriority for network interfaces
2 properties
PodRestartReport
object
InspectPodInfraConfig
object
InspectPodInfraConfig contains the configuration of the pod's infra container.
20 properties
OverlayVolume
object
OverlayVolume holds information about an overlay volume that will be mounted into the container.
3 properties
PodRmReport
object
Type
string
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
PlayKubeReport
object
LinuxDeviceCgroup
object
LinuxDeviceCgroup represents a device rule for the devices specified to the device controller
5 properties
PerNetworkOptions
object
5 properties
AutoUserNsOptions
object
6 properties
PodSpecGenerator
object
PodSpecGenerator describes options to create a pod
44 properties
TmpfsOptions
object
3 properties
VolumeOptions
object
4 properties
LinuxCPU
object
LinuxCPU for Linux cgroup 'cpu' resource management
9 properties
Mount
object
10 properties
ErrorModel
object
ErrorModel is used in remote connections with podman
3 properties
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
PodStatsReport
object
InspectPodData
object
InspectPodData contains detailed information on a pod's configuration and state. It is used as the output of Inspect on pods.
35 properties
NamespaceMode
string
PodPruneReport
object
PodPauseReport
object
LinuxRdma
object
LinuxRdma for Linux cgroup 'rdma' resource management (Linux 4.11)
2 properties
IDResponse
object
1 property 1 required
ListPodsReport
object
LinuxHugepageLimit
object
Default to reservation limits if supported. Otherwise fallback to page fault limits.
2 properties
BindOptions
object
5 properties
ImageOptions
object
1 property
PortMapping
object
5 properties
LinuxPids
object
LinuxPids for Linux cgroup 'pids' resource management (Linux 4.3)
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

podman-pods-api-openapi.yml Raw ↑

Other APIs Podman publishes across the network.

Podman artifacts API
Podman containers API
Podman containers (compat) API
Podman exec API
Podman exec (compat) API
Podman images API
Podman images (compat) API
Podman manifests API
Podman networks API
Podman networks (compat) API
Podman quadlets API
Podman secrets API
Where this information came from

This is an independent, third-party profile of Podman pods API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.