supports a RESTful API for the Libpod library — containers

naftiko: 1.0.0-alpha2
info:
  label: supports a RESTful API for the Libpod library — containers
  description: 'supports a RESTful API for the Libpod library — containers. 37 operations. Lead operation: Commit. Self-contained
    Naftiko capability covering one Podman business surface.'
  tags:
  - Podman
  - containers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PODMAN_API_KEY: PODMAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: podman-containers
    baseUri: http://podman.io
    description: supports a RESTful API for the Libpod library — containers business capability. Self-contained, no shared
      references.
    resources:
    - name: libpod-commit
      path: /libpod/commit
      operations:
      - name: imagecommitlibpod
        method: POST
        description: Commit
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: container
          in: query
          type: string
          description: the name or ID of a container
          required: true
        - name: author
          in: query
          type: string
          description: author of the image
        - name: changes
          in: query
          type: array
          description: instructions to apply while committing in Dockerfile format (i.e. "CMD=/bin/foo")
        - name: comment
          in: query
          type: string
          description: commit message
        - name: format
          in: query
          type: string
          description: format of the image manifest and metadata (default "oci")
        - name: pause
          in: query
          type: boolean
          description: pause the container before committing it
        - name: squash
          in: query
          type: boolean
          description: squash the container before committing it
        - name: repo
          in: query
          type: string
          description: the repository name for the created image
        - name: stream
          in: query
          type: boolean
          description: output from commit process
        - name: tag
          in: query
          type: string
          description: tag name for the created image
    - name: libpod-containers-create
      path: /libpod/containers/create
      operations:
      - name: containercreatelibpod
        method: POST
        description: Create a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: create
          in: body
          type: string
          description: attributes for creating a container
          required: true
    - name: libpod-containers-json
      path: /libpod/containers/json
      operations:
      - name: containerlistlibpod
        method: GET
        description: List containers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: all
          in: query
          type: boolean
          description: Return all containers. By default, only running containers are shown
        - name: limit
          in: query
          type: integer
          description: Return this number of most recently created containers, including non-running ones.
        - name: last
          in: query
          type: integer
          description: Alias for `limit`. Return this number of most recently created containers.
        - name: external
          in: query
          type: boolean
          description: Return containers created by external tools that use container storage.
        - name: namespace
          in: query
          type: boolean
          description: Include namespace information
        - name: pod
          in: query
          type: boolean
          description: Ignored. Previously included details on pod name and ID that are currently included by default.
        - name: size
          in: query
          type: boolean
          description: Return the size of container as fields SizeRw and SizeRootFs.
        - name: sync
          in: query
          type: boolean
          description: Sync container state with OCI runtime
        - 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:'
    - name: libpod-containers-prune
      path: /libpod/containers/prune
      operations:
      - name: containerprunelibpod
        method: POST
        description: Delete stopped containers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filters
          in: query
          type: string
          description: 'Filters to process on the prune list, encoded as JSON (a `map[string][]string`).  Available filters:'
    - name: libpod-containers-showmounted
      path: /libpod/containers/showmounted
      operations:
      - name: containershowmountedlibpod
        method: GET
        description: Show mounted containers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: libpod-containers-stats
      path: /libpod/containers/stats
      operations:
      - name: containersstatsalllibpod
        method: GET
        description: Get stats for one or more containers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: containers
          in: query
          type: array
          description: names or IDs of containers
        - name: stream
          in: query
          type: boolean
          description: Stream the output
        - name: interval
          in: query
          type: integer
          description: Time in seconds between stats reports
        - name: all
          in: query
          type: boolean
          description: Provide statistics for all running containers
    - name: libpod-containers-name
      path: /libpod/containers/{name}
      operations:
      - name: containerdeletelibpod
        method: DELETE
        description: Delete container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: depend
          in: query
          type: boolean
          description: additionally remove containers that depend on the container to be removed
        - name: force
          in: query
          type: boolean
          description: force stop container if running
        - name: ignore
          in: query
          type: boolean
          description: ignore errors when the container to be removed does not existxo
        - name: timeout
          in: query
          type: integer
          description: number of seconds to wait before killing container when force removing
        - name: v
          in: query
          type: boolean
          description: delete volumes
    - name: libpod-containers-name-archive
      path: /libpod/containers/{name}/archive
      operations:
      - name: putcontainerarchivelibpod
        method: PUT
        description: Copy files into a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: container name or id
          required: true
        - name: path
          in: query
          type: string
          description: Path to a directory in the container to extract
          required: true
        - name: pause
          in: query
          type: boolean
          description: pause the container while copying (defaults to true)
        - name: request
          in: body
          type: string
          description: tarfile of files to copy into the container
    - name: libpod-containers-name-attach
      path: /libpod/containers/{name}/attach
      operations:
      - name: containerattachlibpod
        method: POST
        description: Attach to a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: detachKeys
          in: query
          type: string
          description: keys to use for detaching from the container
        - name: logs
          in: query
          type: boolean
          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: boolean
          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: boolean
          description: Attach to container STDOUT
        - name: stderr
          in: query
          type: boolean
          description: Attach to container STDERR
        - name: stdin
          in: query
          type: boolean
          description: Attach to container STDIN
    - name: libpod-containers-name-changes
      path: /libpod/containers/{name}/changes
      operations:
      - name: containerchangeslibpod
        method: GET
        description: Report on changes to container's filesystem; adds, deletes or modifications.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or id of the container
          required: true
        - 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
    - name: libpod-containers-name-checkpoint
      path: /libpod/containers/{name}/checkpoint
      operations:
      - name: containercheckpointlibpod
        method: POST
        description: Checkpoint a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: keep
          in: query
          type: boolean
          description: keep all temporary checkpoint files
        - name: leaveRunning
          in: query
          type: boolean
          description: leave the container running after writing checkpoint to disk
        - name: tcpEstablished
          in: query
          type: boolean
          description: checkpoint a container with established TCP connections
        - name: export
          in: query
          type: boolean
          description: export the checkpoint image to a tar.gz
        - name: ignoreRootFS
          in: query
          type: boolean
          description: do not include root file-system changes when exporting. can only be used with export
        - name: ignoreVolumes
          in: query
          type: boolean
          description: do not include associated volumes. can only be used with export
        - name: preCheckpoint
          in: query
          type: boolean
          description: dump the container's memory information only, leaving the container running. only works on runc 1.0-rc
            or higher
        - name: withPrevious
          in: query
          type: boolean
          description: check out the container with previous criu image files in pre-dump. only works on runc 1.0-rc or higher
        - name: fileLocks
          in: query
          type: boolean
          description: checkpoint a container with filelocks
        - name: printStats
          in: query
          type: boolean
          description: add checkpoint statistics to the returned CheckpointReport
    - name: libpod-containers-name-exists
      path: /libpod/containers/{name}/exists
      operations:
      - name: containerexistslibpod
        method: GET
        description: Check if container exists
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
    - name: libpod-containers-name-export
      path: /libpod/containers/{name}/export
      operations:
      - name: containerexportlibpod
        method: GET
        description: Export a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
    - name: libpod-containers-name-healthcheck
      path: /libpod/containers/{name}/healthcheck
      operations:
      - name: containerhealthchecklibpod
        method: GET
        description: Run a container's healthcheck
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
    - name: libpod-containers-name-init
      path: /libpod/containers/{name}/init
      operations:
      - name: containerinitlibpod
        method: POST
        description: Initialize a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
    - name: libpod-containers-name-json
      path: /libpod/containers/{name}/json
      operations:
      - name: containerinspectlibpod
        method: GET
        description: Inspect container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: size
          in: query
          type: boolean
          description: display filesystem usage
    - name: libpod-containers-name-kill
      path: /libpod/containers/{name}/kill
      operations:
      - name: containerkilllibpod
        method: POST
        description: Kill container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: signal
          in: query
          type: string
          description: signal to be sent to container, either by integer or SIG_ name
    - name: libpod-containers-name-logs
      path: /libpod/containers/{name}/logs
      operations:
      - name: containerlogslibpod
        method: GET
        description: Get container logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: follow
          in: query
          type: boolean
          description: Keep connection after returning logs.
        - name: stdout
          in: query
          type: boolean
          description: Return logs from stdout
        - name: stderr
          in: query
          type: boolean
          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: boolean
          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
    - name: libpod-containers-name-mount
      path: /libpod/containers/{name}/mount
      operations:
      - name: containermountlibpod
        method: POST
        description: Mount a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: external
          in: query
          type: boolean
          description: Include external containers that are not managed by Podman.
    - name: libpod-containers-name-pause
      path: /libpod/containers/{name}/pause
      operations:
      - name: containerpauselibpod
        method: POST
        description: Pause a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
    - name: libpod-containers-name-rename
      path: /libpod/containers/{name}/rename
      operations:
      - name: containerrenamelibpod
        method: POST
        description: Rename an existing container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Full or partial ID or full name of the container to rename
          required: true
        - name: name
          in: query
          type: string
          description: New name for the container
          required: true
    - name: libpod-containers-name-resize
      path: /libpod/containers/{name}/resize
      operations:
      - name: containerresizelibpod
        method: POST
        description: Resize a container's TTY
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: h
          in: query
          type: integer
          description: Height to set for the terminal, in characters
        - name: w
          in: query
          type: integer
          description: Width to set for the terminal, in characters
        - name: running
          in: query
          type: boolean
          description: Ignore containers not running errors
    - name: libpod-containers-name-restart
      path: /libpod/containers/{name}/restart
      operations:
      - name: containerrestartlibpod
        method: POST
        description: Restart a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: t
          in: query
          type: integer
          description: number of seconds to wait before killing container (Docker compatibility)
        - name: timeout
          in: query
          type: integer
          description: number of seconds to wait before killing container
    - name: libpod-containers-name-restore
      path: /libpod/containers/{name}/restore
      operations:
      - name: containerrestorelibpod
        method: POST
        description: Restore a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or id of the container
          required: true
        - name: name
          in: query
          type: string
          description: the name of the container when restored from a tar. can only be used with import
        - name: keep
          in: query
          type: boolean
          description: keep all temporary checkpoint files
        - name: tcpEstablished
          in: query
          type: boolean
          description: restore a container with established TCP connections
        - name: tcpClose
          in: query
          type: boolean
          description: restore a container but close the TCP connections
        - name: import
          in: query
          type: boolean
          description: import the restore from a checkpoint tar.gz
        - name: ignoreRootFS
          in: query
          type: boolean
          description: do not include root file-system changes when exporting. can only be used with import
        - name: ignoreVolumes
          in: query
          type: boolean
          description: do not restore associated volumes. can only be used with import
        - name: ignoreStaticIP
          in: query
          type: boolean
          description: ignore IP address if set statically
        - name: ignoreStaticMAC
          in: query
          type: boolean
          description: ignore MAC address if set statically
        - name: fileLocks
          in: query
          type: boolean
          description: restore a container with file locks
        - name: printStats
          in: query
          type: boolean
          description: add restore statistics to the returned RestoreReport
        - name: pod
          in: query
          type: string
          description: pod to restore into
    - name: libpod-containers-name-start
      path: /libpod/containers/{name}/start
      operations:
      - name: containerstartlibpod
        method: POST
        description: Start a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - 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 _.'
    - name: libpod-containers-name-stats
      path: /libpod/containers/{name}/stats
      operations:
      - name: containerstatslibpod
        method: GET
        description: Get stats for a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: stream
          in: query
          type: boolean
          description: Stream the output
    - name: libpod-containers-name-stop
      path: /libpod/containers/{name}/stop
      operations:
      - name: containerstoplibpod
        method: POST
        description: Stop a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: timeout
          in: query
          type: integer
          description: number of seconds to wait before killing container
        - name: ignore
          in: query
          type: boolean
          description: do not return error if container is already stopped
    - name: libpod-containers-name-top
      path: /libpod/containers/{name}/top
      operations:
      - name: containertoplibpod
        method: GET
        description: List processes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name of container to query for processes (As of version 1.xx)
          required: true
        - name: stream
          in: query
          type: boolean
          description: when true, repeatedly stream the latest output (As of version 4.0)
        - name: delay
          in: query
          type: integer
          description: if streaming, delay in seconds between updates. Must be >1. (As of version 4.0)
        - name: ps_args
          in: query
          type: array
          description: arguments to pass to ps such as aux.
    - name: libpod-containers-name-unmount
      path: /libpod/containers/{name}/unmount
      operations:
      - name: containerunmountlibpod
        method: POST
        description: Unmount a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
    - name: libpod-containers-name-unpause
      path: /libpod/containers/{name}/unpause
      operations:
      - name: containerunpauselibpod
        method: POST
        description: Unpause Container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
    - name: libpod-containers-name-update
      path: /libpod/containers/{name}/update
      operations:
      - name: containerupdatelibpod
        method: POST
        description: Updates the configuration of an existing container, allowing changes to resource limits and healthchecks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Full or partial ID or full name of the container to update
          required: true
        - name: restartPolicy
          in: query
          type: string
          description: New restart policy for the container.
        - name: restartRetries
          in: query
          type: integer
          description: New amount of retries for the container's restart policy. Only allowed if restartPolicy is set to on-failure
        - name: config
          in: body
          type: string
          description: attributes for updating the container
    - name: libpod-containers-name-wait
      path: /libpod/containers/{name}/wait
      operations:
      - name: containerwaitlibpod
        method: POST
        description: Wait on a container
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: the name or ID of the container
          required: true
        - name: condition
          in: query
          type: array
          description: Conditions to wait for. If no condition provided the 'exited' condition is assumed.
        - name: interval
          in: query
          type: string
          description: Time Interval to wait before polling for completion.
    - name: libpod-generate-kube
      path: /libpod/generate/kube
      operations:
      - name: generatekubelibpod
        method: GET
        description: Generate a Kubernetes YAML file.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: names
          in: query
          type: array
          description: Name or ID of the container or pod.
          required: true
        - name: service
          in: query
          type: boolean
          description: Generate YAML for a Kubernetes service object.
        - name: type
          in: query
          type: string
          description: Generate YAML for the given Kubernetes kind.
        - name: replicas
          in: query
          type: integer
          description: Set the replica number for Deployment kind.
        - name: noTrunc
          in: query
          type: boolean
          description: don't truncate annotations to the Kubernetes maximum length of 63 characters
        - name: podmanOnly
          in: query
          type: boolean
          description: add podman-only reserved annotations in generated YAML file (cannot be used by Kubernetes)
    - name: libpod-generate-name-systemd
      path: /libpod/generate/{name}/systemd
      operations:
      - name: generatesystemdlibpod
        method: GET
        description: Generate Systemd Units
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name or ID of the container or pod.
          required: true
        - name: useName
          in: query
          type: boolean
          description: Use container/pod names instead of IDs.
        - name: new
          in: query
          type: boolean
          description: Create a new container instead of starting an existing one.
        - name: noHeader
          in: query
          type: boolean
          description: Do not generate the header including the Podman version and the timestamp.
        - name: startTimeout
          in: query
          type: integer
          description: Start timeout in seconds.
        - name: stopTimeout
          in: query
          type: integer
          description: Stop timeout in seconds.
        - name: restartPolicy
          in: query
          type: string
          description: Systemd restart-policy.
        - name: containerPrefix
          in: query
          type: string
          description: Systemd unit name prefix for containers.
        - name: podPrefix
          in: query
          type: string
          description: Systemd unit name prefix for pods.
        - name: separator
          in: query
          type: string
          description: Systemd unit name separator between name/id and prefix.
        - name: restartSec
          in: query
          type: integer
          description: Configures the time to sleep before restarting a service.
        - name: wants
          in: query
          type: array
          description: Systemd Wants list for the container or pods.
        - name: after
          in: query
          type: array
          description: Systemd After list for the container or pods.
        - name: requires
          in: query
          type: array
          description: Systemd Requires list for the container or pods.
        - name: additionalEnvVariables
          in: query
          type: array
          description: Set environment variables to

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