supports a RESTful API for the Libpod library

naftiko: 1.0.0-alpha2
info:
  label: supports a RESTful API for the Libpod library
  description: 'This documentation describes the Podman v2.x+ RESTful API. It consists of a Docker-compatible API and a Libpod
    API providing support for Podman’s unique features such as pods. To start the service and keep it running for 5,000 seconds
    (-t 0 runs forever): podman system service -t 5000 & You can then use cURL on the socket using requests documented below.
    NOTE: if you install the package podman-docker, it will create a symbolic link for /run/docker.sock to /run/podman/podman.sock
    NOTE: Some fields in the API response JSON are encoded as omitempty, which means that if said field has a zero value'
  tags:
  - Podman
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: podman
    baseUri: https://api.example.com
    description: supports a RESTful API for the Libpod library HTTP API.
    resources:
    - name: auth
      path: /auth
      operations:
      - name: systemauth
        method: POST
        description: Check auth configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: build
      path: /build
      operations:
      - name: imagebuild
        method: POST
        description: Build image
        inputParameters:
        - name: Content-Type
          in: header
          type: string
        - name: X-Registry-Config
          in: header
          type: string
        - name: dockerfile
          in: query
          type: string
          description: Path within the build context to the `Dockerfile`. This is ignored if remote is specified and points
            to an external `Dockerfile`.
        - name: t
          in: query
          type: string
          description: A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag, the default
            latest value is assumed. You can provide several t para
        - name: extrahosts
          in: query
          type: string
          description: TBD Extra hosts to add to /etc/hosts (As of version 1.xx)
        - name: nohosts
          in: query
          type: string
          description: Not to create /etc/hosts when building the image
        - name: remote
          in: query
          type: string
          description: A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s
            contents are placed into a file called Dockerfile and the im
        - name: retry
          in: query
          type: string
          description: Number of times to retry in case of failure when performing push/pull.
        - name: retry-delay
          in: query
          type: string
          description: Delay between retries in case of push/pull failures.
        - name: q
          in: query
          type: string
          description: Suppress verbose build output
        - name: nocache
          in: query
          type: string
          description: Do not use the cache when building the image (As of version 1.xx)
        - name: cachefrom
          in: query
          type: string
          description: JSON array of images used to build cache resolution (As of version 1.xx)
        - name: pull
          in: query
          type: string
          description: Attempt to pull the image even if an older image exists locally (As of version 1.xx)
        - name: rm
          in: query
          type: string
          description: Remove intermediate containers after a successful build (As of version 1.xx)
        - name: forcerm
          in: query
          type: string
          description: Always remove intermediate containers, even upon failure (As of version 1.xx)
        - name: memory
          in: query
          type: string
          description: Memory is the upper limit (in bytes) on how much memory running containers can use (As of version 1.xx)
        - name: memswap
          in: query
          type: string
          description: MemorySwap limits the amount of memory and swap together (As of version 1.xx)
        - name: cpushares
          in: query
          type: string
          description: CPUShares (relative weight (As of version 1.xx)
        - name: cpusetcpus
          in: query
          type: string
          description: CPUSetCPUs in which to allow execution (0-3, 0,1) (As of version 1.xx)
        - name: cpuperiod
          in: query
          type: string
          description: CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period (As of version 1.xx)
        - name: cpuquota
          in: query
          type: string
          description: CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota (As of version 1.xx)
        - name: buildargs
          in: query
          type: string
          description: JSON map of string pairs denoting build-time variables. For example, the build argument `Foo` with
            the value of `bar` would be encoded in JSON as `["Foo":"bar"]
        - name: shmsize
          in: query
          type: string
          description: ShmSize is the "size" value to use when mounting an shmfs on the container's /dev/shm directory. Default
            is 64MB (As of version 1.xx)
        - name: squash
          in: query
          type: string
          description: Silently ignored. Squash the resulting images layers into a single layer (As of version 1.xx)
        - name: save-stages
          in: query
          type: string
          description: Preserve intermediate stage images instead of removing them after the build completes. By default,
            they are removed to save space. However, they can be useful f
        - name: stage-labels
          in: query
          type: string
          description: 'Add metadata labels to all intermediate stage images of a multistage build, including the final image.
            If set to true, save-stages must also be set to true. If '
        - name: labels
          in: query
          type: string
          description: JSON map of key, value pairs to set as labels on the new image (As of version 1.xx)
        - name: networkmode
          in: query
          type: string
          description: 'Sets the networking mode for the run commands during build. Supported standard values are: * `bridge`
            limited to containers within a single host, port mapping r'
        - name: platform
          in: query
          type: string
          description: Platform format os[/arch[/variant]] Can be comma separated list for multi arch builds. (As of version
            1.xx)
        - name: target
          in: query
          type: string
          description: Target build stage (As of version 1.xx)
        - name: outputs
          in: query
          type: string
          description: output configuration TBD (As of version 1.xx)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: commit
      path: /commit
      operations:
      - name: imagecommit
        method: POST
        description: New Image
        inputParameters:
        - name: container
          in: query
          type: string
          description: the name or ID of a container
        - name: repo
          in: query
          type: string
          description: the repository name for the created image
        - name: tag
          in: query
          type: string
          description: tag name for the created image
        - name: comment
          in: query
          type: string
          description: commit message
        - name: author
          in: query
          type: string
          description: author of the image
        - name: pause
          in: query
          type: string
          description: pause the container before committing it
        - name: changes
          in: query
          type: string
          description: instructions to apply while committing in Dockerfile format
        - name: squash
          in: query
          type: string
          description: squash newly built layers into a single new layer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name
      path: /containers/{name}
      operations:
      - name: containerdelete
        method: DELETE
        description: Remove a container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: force
          in: query
          type: string
          description: If the container is running, kill it before removing it.
        - name: v
          in: query
          type: string
          description: Remove the volumes associated with the container.
        - name: link
          in: query
          type: string
          description: not supported
        - name: ignore
          in: query
          type: string
          description: Ignore if a specified container does not exist.
        - name: depend
          in: query
          type: string
          description: Remove container dependencies.
        - name: timeout
          in: query
          type: string
          description: Number of seconds to wait before forcibly stopping the container.
        - name: volumes
          in: query
          type: string
          description: Remove anonymous volumes associated with the container.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-archive
      path: /containers/{name}/archive
      operations:
      - name: containerarchive
        method: GET
        description: Get files from a container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: container name or id
        - name: path
          in: query
          type: string
          required: true
          description: Path to a directory in the container to extract
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putcontainerarchive
        method: PUT
        description: Put files into a container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: container name or id
        - name: path
          in: query
          type: string
          required: true
          description: Path to a directory in the container to extract
        - name: noOverwriteDirNonDir
          in: query
          type: string
          description: if unpacking the given content would cause an existing directory to be replaced with a non-directory
            and vice versa (1 or true)
        - name: copyUIDGID
          in: query
          type: string
          description: copy UID/GID maps to the dest file or di (1 or true)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-attach
      path: /containers/{name}/attach
      operations:
      - name: containerattach
        method: POST
        description: Attach to a container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: detachKeys
          in: query
          type: string
          description: keys to use for detaching from the container
        - name: logs
          in: query
          type: string
          description: Stream all logs from the container across the connection. Happens before streaming attach (if requested).
            At least one of logs or stream must be set
        - name: stream
          in: query
          type: string
          description: Attach to the container. If unset, and logs is set, only the container's logs will be sent. At least
            one of stream or logs must be set
        - name: stdout
          in: query
          type: string
          description: Attach to container STDOUT
        - name: stderr
          in: query
          type: string
          description: Attach to container STDERR
        - name: stdin
          in: query
          type: string
          description: Attach to container STDIN
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-changes
      path: /containers/{name}/changes
      operations:
      - name: containerchanges
        method: GET
        description: Report on changes to container's filesystem; adds, deletes or modifications.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or id of the container
        - name: parent
          in: query
          type: string
          description: specify a second layer which is used to compare against it instead of the parent layer
        - name: diffType
          in: query
          type: string
          description: select what you want to match, default is all
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-exec
      path: /containers/{name}/exec
      operations:
      - name: containerexec
        method: POST
        description: Create an exec instance
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: name of container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-export
      path: /containers/{name}/export
      operations:
      - name: containerexport
        method: GET
        description: Export a container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-json
      path: /containers/{name}/json
      operations:
      - name: containerinspect
        method: GET
        description: Inspect container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or id of the container
        - name: size
          in: query
          type: string
          description: include the size of the container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-kill
      path: /containers/{name}/kill
      operations:
      - name: containerkill
        method: POST
        description: Kill container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: all
          in: query
          type: string
          description: Send kill signal to all containers
        - name: signal
          in: query
          type: string
          description: signal to be sent to container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-logs
      path: /containers/{name}/logs
      operations:
      - name: containerlogs
        method: GET
        description: Get container logs
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: follow
          in: query
          type: string
          description: Keep connection after returning logs.
        - name: stdout
          in: query
          type: string
          description: Return logs from stdout
        - name: stderr
          in: query
          type: string
          description: Return logs from stderr
        - name: since
          in: query
          type: string
          description: Only return logs since this time, as a UNIX timestamp
        - name: until
          in: query
          type: string
          description: Only return logs before this time, as a UNIX timestamp
        - name: timestamps
          in: query
          type: string
          description: Add timestamps to every log line
        - name: tail
          in: query
          type: string
          description: Only return this number of log lines from the end of the logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-pause
      path: /containers/{name}/pause
      operations:
      - name: containerpause
        method: POST
        description: Pause container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-rename
      path: /containers/{name}/rename
      operations:
      - name: containerrename
        method: POST
        description: Rename an existing container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: Full or partial ID or full name of the container to rename
        - name: name
          in: query
          type: string
          required: true
          description: New name for the container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-resize
      path: /containers/{name}/resize
      operations:
      - name: containerresize
        method: POST
        description: Resize a container's TTY
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: h
          in: query
          type: string
          description: Height to set for the terminal, in characters
        - name: w
          in: query
          type: string
          description: Width to set for the terminal, in characters
        - name: running
          in: query
          type: string
          description: Ignore containers not running errors
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-restart
      path: /containers/{name}/restart
      operations:
      - name: containerrestart
        method: POST
        description: Restart container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: t
          in: query
          type: string
          description: timeout before sending kill signal to container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-start
      path: /containers/{name}/start
      operations:
      - name: containerstart
        method: POST
        description: Start a container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: detachKeys
          in: query
          type: string
          description: 'Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value>
            where <value> is one of: a-z, @, ^, [, , or _.'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-stats
      path: /containers/{name}/stats
      operations:
      - name: containerstats
        method: GET
        description: Get stats for a container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: stream
          in: query
          type: string
          description: Stream the output
        - name: one-shot
          in: query
          type: string
          description: Provide a one-shot response in which preCPU stats are blank, resulting in a single cycle return.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-stop
      path: /containers/{name}/stop
      operations:
      - name: containerstop
        method: POST
        description: Stop a container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: t
          in: query
          type: string
          description: number of seconds to wait before killing container
        - name: timeout
          in: query
          type: string
          description: Number of seconds to wait before killing the container (libpod alias for `t`).
        - name: ignore
          in: query
          type: string
          description: Do not return an error if the container is already stopped.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-top
      path: /containers/{name}/top
      operations:
      - name: containertop
        method: GET
        description: List processes running inside a container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: ps_args
          in: query
          type: string
          description: arguments to pass to ps such as aux.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-unpause
      path: /containers/{name}/unpause
      operations:
      - name: containerunpause
        method: POST
        description: Unpause container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-update
      path: /containers/{name}/update
      operations:
      - name: containerupdate
        method: POST
        description: Update configuration of an existing container, allowing changes to resource limits
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: Full or partial ID or full name of the container to rename
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-name-wait
      path: /containers/{name}/wait
      operations:
      - name: containerwait
        method: POST
        description: Wait on a container
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        - name: condition
          in: query
          type: string
          description: 'Wait condition. Valid values are: - not-running (default) - return when the container is not running
            (stopped, exited, or was never started). - next-exit - wait'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-create
      path: /containers/create
      operations:
      - name: containercreate
        method: POST
        description: Create a container
        inputParameters:
        - name: name
          in: query
          type: string
          description: container name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-json
      path: /containers/json
      operations:
      - name: containerlist
        method: GET
        description: List containers
        inputParameters:
        - name: all
          in: query
          type: string
          description: Return all containers. By default, only running containers are shown
        - name: external
          in: query
          type: string
          description: Return containers in storage not controlled by Podman
        - name: limit
          in: query
          type: string
          description: Return this number of most recently created containers, including non-running ones.
        - name: size
          in: query
          type: string
          description: Return the size of container as fields SizeRw and SizeRootFs.
        - name: filters
          in: query
          type: string
          description: 'A JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available
            filters: - `ancestor`=(`<image-name>[:<tag>]`, `<imag'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: containers-prune
      path: /containers/prune
      operations:
      - name: containerprune
        method: POST
        description: Delete stopped containers
        inputParameters:
        - name: filters
          in: query
          type: string
          description: 'Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters:
            - `until=<timestamp>` Prune containers created before this t'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: events
      path: /events
      operations:
      - name: systemevents
        method: GET
        description: Get events
        inputParameters:
        - name: since
          in: query
          type: string
          description: start streaming events from this time
        - name: until
          in: query
          type: string
          description: stop streaming events later than this
        - name: filters
          in: query
          type: string
          description: JSON encoded map[string][]string of constraints
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: exec-id-json
      path: /exec/{id}/json
      operations:
      - name: execinspect
        method: GET
        description: Inspect an exec instance
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
          description: Exec instance ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: exec-id-resize
      path: /exec/{id}/resize
      operations:
      - name: execresize
        method: POST
        description: Resize an exec instance
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
          description: Exec instance ID
        - name: h
          in: query
          type: string
          description: Height of the TTY session in characters
        - name: w
          in: query
          type: string
          description: Width of the TTY session in characters
        - name: running
          in: query
          type: string
          description: Ignore containers not running errors
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: exec-id-start
      path: /exec/{id}/start
      operations:
      - name: execstart
        method: POST
        description: Start an exec instance
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
          description: Exec instance ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: images-name
      path: /images/{name}
      operations:
      - name: imagedelete
        method: DELETE
        description: Remove Image
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: name or ID of image to delete
        - name: force
          in: query
          type: string
          description: Remove the image even if it is being used by stopped containers or has other tags
        - name: noprune
          in: query
          type: string
          description: do not remove dangling parent images
        - name: ignore
          in: query
          type: string
          description: Ignore if a specified image does not exist and do not throw an error.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: images-name-get
      path: /images/{name}/get
      operations:
      - name: imageget
        method: GET
        description: Export an image
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: images-name-history
      path: /images/{name}/history
      operations:
      - name: imagehistory
        method: GET
        description: History of an image
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: images-name-json
      path: /images/{name}/json
      operations:
      - name: imageinspect
        method: GET
        description: Inspect an image
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: the name or ID of the container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: images-name-push
      path: /images/{name}/push
      operations:
      - name: imagepush
        method: POST
        description: Push Image
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: Name of image to push.
        - name: tag
          in: query
          type: string
          description: The tag to associate with the image on the registry.
        - name: all
          in: query
          type: string
          description: All indicates whether to push all images related to the image list
        - name: compress
          in: query
          type: string
          description: Use compression on image.
        - name: destination
          in: query
          type: string
          description: Allows for pushing the image to a different destination than the image refers to.
        - name: format
          in: query
          type: string
          description: Manifest type (oci, v2s1, or v2s2) to use when pushing an image. Default is manifest type of source,
            with fallbacks.
        - name: tlsVerify
          in: query
          type: string
          description: Require TLS verification.
        - name: X-Registry-Auth
          in: header
          type: string
          

# --- truncated at 32 KB (136 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/podman/refs/heads/main/capabilities/podman-capability.yaml