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 system API

Actions related to Podman engine

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

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

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

7 operations 7 paths 24 schemas 5 GET2 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 7

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

system 7

Actions related to Podman engine

GET
/libpod/_ping
Ping service
SystemPing → 200500
GET
/libpod/events
Get events
SystemEventsLibpod 4 params → 200500
GET
/libpod/info
Get info
SystemInfoLibpod → 200500
POST
/libpod/system/check
Performs consistency checks on storage, optionally removing items which fail checks
SystemCheckLibpod 4 params → 200400500
GET
/libpod/system/df
Show disk usage
SystemDataUsageLibpod → 200500
POST
/libpod/system/prune
Prune unused data
SystemPruneLibpod 5 params → 200400500
GET
/libpod/version
Component Version information
SystemVersionLibpod → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are HostInfo (34 properties), StoreInfo (12 properties), Version (9 properties), SecurityInfo (6 properties). Each schema is shown below with its type and property counts.

NetworkBackend
string
ComponentVersion
object
ServiceOptions provides the input for starting an API and sidecar pprof services
SystemDfReport
object
ServiceOptions provides the input for starting an API and sidecar pprof services
StoreInfo
object
StoreInfo describes the container storage and its attributes
12 properties
ImageStore
object
ImageStore describes the image store. Right now only the number of images present
1 property
Version
object
Version is an output struct for API
9 properties
DNSNetworkInfo
object
3 properties
OCIRuntimeInfo
object
OCIRuntimeInfo describes the runtime (crun or runc) being used with podman
4 properties
RemoteSocket
object
RemoteSocket describes information about the API socket
2 properties
Plugins
object
4 properties
IDMappings
object
IDMappings describe the GID and UID mappings
2 properties
ErrorModel
object
ErrorModel is used in remote connections with podman
3 properties
NetworkInfo
object
6 properties
CPUUsage
object
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
PastaInfo
object
PastaInfo describes the pasta executable that is being used
3 properties
SystemPruneReport
object
ServiceOptions provides the input for starting an API and sidecar pprof services
LibpodInfo
object
Info is the overall struct that describes the host system running libpod/podman
5 properties
SystemCheckReport
object
ServiceOptions provides the input for starting an API and sidecar pprof services
ConmonInfo
object
ConmonInfo describes the conmon executable being used
3 properties
DistributionInfo
object
DistributionInfo describes the host distribution for libpod
4 properties
ContainerStore
object
ContainerStore describes the quantity of containers in the store by status
4 properties
SecurityInfo
object
SecurityInfo describes the libpod host
6 properties
HostInfo
object
HostInfo describes the libpod host
34 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

podman-system-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 pods API
Podman quadlets API
Where this information came from

This is an independent, third-party profile of Podman system 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.