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 volumes (compat) API

Actions related to volumes for the compatibility endpoints

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

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

5 operations 4 paths 22 schemas 1 DELETE2 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 5

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

volumes (compat) 5

Actions related to volumes for the compatibility endpoints

GET
/volumes
List volumes
VolumeList 1 param → 200500
DELETE
/volumes/{name}
Remove volume
VolumeDelete 3 params → 204404409500
GET
/volumes/{name}
Inspect volume
VolumeInspect 1 param → 200500
POST
/volumes/create
Create a volume
VolumeCreate body → 201500
POST
/volumes/prune
Prune volumes
VolumePrune 1 param → 200500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Volume (10 properties), Version (9 properties), ClusterVolume (7 properties), ClusterVolumeSpec (6 properties). Each schema is shown below with its type and property counts.

Availability
string
TopologyRequirement
object
TopologyRequirement expresses the user's requirements for a volume's accessible topology.
2 properties
ClusterVolumeSpec
object
6 properties
Secret
object
5 properties
TypeBlock
object
Intentionally empty.
Version
object
Version is an output struct for API
9 properties
UsageData
object
UsageData Usage details about the volume. This information is used by the GET /system/df endpoint, and omitted in other endpoints.
2 properties 2 required
ListResponse
object
Volume list response
2 properties
TypeMount
object
TypeMount contains options for using a volume as a Mount-type volume.
2 properties
PublishStatus
object
PublishStatus represents the status of the volume as published to an individual node
3 properties
volumeCreate
object
Details for creating a volume
4 properties 4 required
SharingMode
string
SharingMode defines the Sharing of a Cluster Volume. This is how Tasks using a Volume at the same time can use it.
PruneReport
object
POST "/volumes/prune"
3 properties
ClusterVolume
object
ClusterVolume contains options and information specific to, and only present on, Swarm CSI cluster volumes.
7 properties
ErrorModel
object
ErrorModel is used in remote connections with podman
3 properties
Info
object
Info contains information about the Volume as a whole as provided by the CSI storage plugin.
4 properties
PublishState
string
PublishState represents the state of a Volume as it pertains to its use on a particular Node.
Scope
string
Scope defines the Scope of a Cluster Volume. This is how many nodes a Volume can be accessed simultaneously on.
Volume
object
Volume volume
10 properties 6 required
Topology
object
This description is taken verbatim from the CSI Spec: A topological domain is a sub-division of a cluster, like "region", "zone", "rack", etc. A topological se…
1 property
CapacityRange
object
CapacityRange describes the minimum and maximum capacity a volume should be created with
2 properties
AccessMode
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

podman-volumes-compat-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 volumes (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.