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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Podman

Podman containers (compat) API

Actions related to containers for the compatibility endpoints

Documentation Provider Profile APIs.io OpenAPI GitHub

Podman containers (compat) 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 (compat). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

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

25 operations 24 paths 60 schemas 1 DELETE9 GET14 POST1 PUT

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
Podman
License
Apache-2.0
Terms of Service
View terms
Resource Areas
1

Paths & Operations 25

Across 24 paths, the API surfaces 25 operations — 1 DELETE, 9 GET, 14 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

containers (compat) 25

Actions related to containers for the compatibility endpoints

POST
/commit
New Image
ImageCommit 8 params → 201404500
DELETE
/containers/{name}
Remove a container
ContainerDelete 8 params → 204400404409500
GET
/containers/{name}/archive
Get files from a container
ContainerArchive 2 params → 200400404500
PUT
/containers/{name}/archive
Put files into a container
PutContainerArchive 4 params body → 200400403404500
POST
/containers/{name}/attach
Attach to a container
ContainerAttach 7 params → 101400404500
GET
/containers/{name}/changes
Report on changes to container's filesystem; adds, deletes or modifications.
ContainerChanges 3 params → 200404500
GET
/containers/{name}/export
Export a container
ContainerExport 1 param → 200404500
GET
/containers/{name}/json
Inspect container
ContainerInspect 2 params → 200404500
POST
/containers/{name}/kill
Kill container
ContainerKill 3 params → 204404409500
GET
/containers/{name}/logs
Get container logs
ContainerLogs 8 params → 200404500
POST
/containers/{name}/pause
Pause container
ContainerPause 1 param → 204404500
POST
/containers/{name}/rename
Rename an existing container
ContainerRename 2 params → 204404409500
POST
/containers/{name}/resize
Resize a container's TTY
ContainerResize 4 params → 200404500
POST
/containers/{name}/restart
Restart container
ContainerRestart 2 params → 204404500
POST
/containers/{name}/start
Start a container
ContainerStart 2 params → 204304404500
GET
/containers/{name}/stats
Get stats for a container
ContainerStats 3 params → 200404500
POST
/containers/{name}/stop
Stop a container
ContainerStop 4 params → 204304404500
GET
/containers/{name}/top
List processes running inside a container
ContainerTop 2 params → 200404500
POST
/containers/{name}/unpause
Unpause container
ContainerUnpause 1 param → 204404500
POST
/containers/{name}/update
Update configuration of an existing container, allowing changes to resource limits
ContainerUpdate 1 param body → 200404500
POST
/containers/{name}/wait
Wait on a container
ContainerWait 2 params → 200404500
POST
/containers/create
Create a container
ContainerCreate 1 param body → 201400404409500
GET
/containers/json
List containers
ContainerList 5 params → 200400500
POST
/containers/prune
Delete stopped containers
ContainerPrune 1 param → 200500
GET
/libpod/containers/{name}/archive
Copy files from a container
ContainerArchiveLibpod 3 params → 200400404500

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are HostConfig (69 properties), CreateContainerConfig (31 properties), containerUpdateRequest (30 properties), InspectResponse (27 properties). Each schema is shown below with its type and property counts.

PortMap
object
Digest
string
The following is an example of the contents of Digest types: sha256:7173b809ca12ec5dee4506cd86be934c4596dd234ee82c0662eac04a8c2c71dc This allows to abstract th…
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…
PidMode
string
Propagation
string
Consistency
string
PortSummary
object
4 properties 2 required
Container
object
22 properties
NetworkSettingsSummary
object
NetworkSettingsSummary provides a summary of container's networks in /containers/json
1 property
containerUpdateRequest
object
Container update
30 properties
Isolation
string
Isolation represents the isolation technology of a container. The supported values are platform specific
Platform
object
5 properties
RootFSStorage
object
1 property
MountPoint
object
This is used for reporting the mountpoints in use by a container.
8 properties
NetworkMode
string
ContainerTopOKBody
object
2 properties
PortSet
object
Driver
object
2 properties
IpcMode
string
HostConfig
object
Here, "non-portable" means "dependent of the host we are running on". Portable information should appear in Config.
69 properties
ContainerState
string
Config
object
It should hold only portable information about the container. Here, "portable" means "independent from the host we are running on". Non-portable information sh…
24 properties
Descriptor
object
This structure provides application/vnd.oci.descriptor.v1+json mediatype when marshalled to JSON.
8 properties
EndpointIPAMConfig
object
EndpointIPAMConfig represents IPAM configurations for the endpoint
3 properties
Type
string
CgroupnsMode
string
CgroupnsMode represents the cgroup namespace mode of the container
RestartPolicyMode
string
Health
object
Health stores information about the container's healthcheck results
3 properties
NetworkSettings
object
NetworkSettings exposes the network settings in the api
4 properties
ContainersPruneReport
object
2 properties
EndpointSettings
object
EndpointSettings stores the network endpoint details
15 properties
NetworkingConfig
object
NetworkingConfig represents the container's networking configuration for each of its interfaces Carries the networking configs specified in the docker run and…
1 property
LogConfig
object
2 properties
State
object
State stores container's running state it's part of ContainerJSONBase and returned by "inspect" command
12 properties
TmpfsOptions
object
3 properties
VolumeOptions
object
4 properties
WeightDevice
object
WeightDevice is a structure that holds device:weight pair
2 properties
Ulimit
object
Users are recommended to use this alias instead of using [units.Ulimit] directly.
CgroupSpec
string
DriverData
object
DriverData handles the data for a storage driver
2 properties 2 required
HealthConfig
object
Mount
object
10 properties
ErrorModel
object
ErrorModel is used in remote connections with podman
3 properties
HealthSummary
object
2 properties
DeviceMapping
object
3 properties
Storage
object
1 property
HealthStatus
string
RootFSStorageSnapshot
object
1 property
ThrottleDevice
object
ThrottleDevice is a structure that holds device:ratepersecond pair
2 properties
DeviceRequest
object
Used by GPU device drivers.
5 properties
UTSMode
string
CreateContainerConfig
object
CreateContainerConfig used when compatible endpoint creates a container
31 properties
InspectResponse
object
endpoint.
27 properties
HealthcheckResult
object
HealthcheckResult stores information about a single run of a healthcheck probe
4 properties
RestartPolicy
object
2 properties
BindOptions
object
5 properties
ImageOptions
object
1 property
ContainerCreateResponse
object
ContainerCreateResponse is the response struct for creating a container
UsernsMode
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

podman-containers-compat-api-openapi.yml Raw ↑

Other APIs Podman publishes across the network.

Podman artifacts API
AE Profile APIs.io
Podman containers API
AE Profile APIs.io
Podman exec API
AE Profile APIs.io
Podman exec (compat) API
AE Profile APIs.io
Podman images API
AE Profile APIs.io
Podman images (compat) API
AE Profile APIs.io
Podman manifests API
AE Profile APIs.io
Podman networks API
AE Profile APIs.io
Podman networks (compat) API
AE Profile APIs.io
Podman pods API
AE Profile APIs.io
Podman quadlets API
AE Profile APIs.io
Podman secrets API
AE Profile APIs.io
#containers (compat)
← Back to P APIs
API Details
ID
podman:podman-containers-compat-api
Base URL
http://d/v6.0.0/libpod
Docs
https://docs.podman.io/en/latest/_static/api.html
Provider
Podman
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=podman-containers-compat-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/podman-containers-compat-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Podman containers (compat) 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.