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- where 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`=(`[:]`, `` 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 description: A base64-encoded auth configuration. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: images-name-tag path: /images/{name}/tag operations: - name: imagetag method: POST description: Tag an image inputParameters: - name: name in: path type: string required: true description: the name or ID of the container - name: repo in: query type: string description: the repository to tag in - name: tag in: query type: string description: the name of the new tag outputRawFormat: json outputParameters: - name: result type: object value: $. - name: images-create path: /images/create operations: - name: imagecreate method: POST description: Create an image inputParameters: - name: X-Registry-Auth in: header type: string description: A base64-encoded auth configuration. - name: fromImage in: query type: string description: Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connec - name: fromSrc in: query type: string description: Source to import. The value may be a URL from which the image can be retrieved or - to read the image from the request body. This parameter may only be used whe - name: repo in: query type: string description: Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image. - name: tag in: query type: string description: Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. - name: message in: query type: string description: Set commit message for imported image. - name: platform in: query type: string description: Platform in the format os[/arch[/variant]] - name: retry in: query type: string description: Number of times to retry in case of failure when performing pull. - name: retryDelay in: query type: string description: Delay between retries in case of pull failures. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: images-get path: /images/get operations: - name: imagegetall method: GET description: Export several images inputParameters: - name: names in: query type: string required: true description: one or more image names or IDs comma separated outputRawFormat: json outputParameters: - name: result type: object value: $. - name: images-json path: /images/json operations: - name: imagelist method: GET description: List Images inputParameters: - name: all in: query type: string description: Show all images. Only images from a final layer (no children) are shown by default. - name: filters in: query type: string description: 'JSON-encoded string containing filters as a `map[string][]string` to process on the images list. Available filters: - `before`=(`[:]`, `` When set to `true` (or `1`), prune only unus' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: images-search path: /images/search operations: - name: imagesearch method: GET description: Search images inputParameters: - name: term in: query type: string description: term to search - name: limit in: query type: string description: maximum number of results - name: filters in: query type: string description: 'JSON-encoded string containing filters as a `map[string][]string` to process on the images list. Available filters: - `is-automated=(true|false)` - `is-official' - name: tlsVerify in: query type: string description: Require HTTPS and verify signatures when contacting registries. - name: listTags in: query type: string description: list the available tags in the repository outputRawFormat: json outputParameters: - name: result type: object value: $. - name: info path: /info operations: - name: systeminfo method: GET description: Get info outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-ping path: /libpod/_ping operations: - name: systemping method: GET description: Ping service outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-artifacts-name path: /libpod/artifacts/{name} operations: - name: artifactdeletelibpod method: DELETE description: Remove an artifact inputParameters: - name: name in: path type: string required: true description: Name or ID of the artifact to remove outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-artifacts-name-extract path: /libpod/artifacts/{name}/extract operations: - name: artifactextractlibpod method: GET description: Extract an artifacts contents inputParameters: - name: name in: path type: string required: true description: Name or digest of the artifact - name: title in: query type: string description: Only extract the file with the given title - name: digest in: query type: string description: Only extract the file with the given digest - name: excludeTitle in: query type: string description: When extracting a single file from an artifact, don't use the files title as the file name in the tar archive outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-artifacts-name-json path: /libpod/artifacts/{name}/json operations: - name: artifactinspectlibpod method: GET description: Inspect an artifact inputParameters: - name: name in: path type: string required: true description: Name or ID of the artifact outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-artifacts-name-push path: /libpod/artifacts/{name}/push operations: - name: artifactpushlibpod method: POST description: Push an artifact inputParameters: - name: name in: path type: string required: true description: Mandatory reference to the artifact (e.g., quay.io/image/artifact:tag) - name: retry in: query type: string description: Number of times to retry in case of failure when performing pull - name: retryDelay in: query type: string description: Delay between retries in case of pull failures (e.g., 10s) - name: tlsVerify in: query type: string description: Require TLS verification - name: X-Registry-Auth in: header type: string description: 'base-64 encoded auth config. Must include the following four values: username, password, email and server address OR simply just an identity token.' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-artifacts-add path: /libpod/artifacts/add operations: - name: artifactaddlibpod method: POST description: Add a file as an artifact inputParameters: - name: name in: query type: string required: true description: Mandatory reference to the artifact (e.g., quay.io/image/artifact:tag) - name: fileName in: query type: string required: true description: Path of the file to be added - name: fileMIMEType in: query type: string description: Optionally set the type of file - name: annotations in: query type: string description: Array of annotation strings e.g "test=true" - name: artifactMIMEType in: query type: string description: Use type to describe an artifact - name: append in: query type: string description: Append files to an existing artifact - name: replace in: query type: string description: Replace an existing artifact with the same name outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-artifacts-json path: /libpod/artifacts/json operations: - name: artifactlistlibpod method: GET description: List artifacts outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-artifacts-local-add path: /libpod/artifacts/local/add operations: - name: artifactlocallibpod method: POST description: Add a local file as an artifact inputParameters: - name: name in: query type: string required: true description: Mandatory reference to the artifact (e.g., quay.io/image/artifact:tag) - name: path in: query type: string required: true description: Absolute path to the local file on the server filesystem to be added - name: fileName in: query type: string required: true description: Name/title of the file within the artifact - name: fileMIMEType in: query type: string description: Optionally set the MIME type of the file - name: annotations in: query type: string description: Array of annotation strings e.g "test=true" - name: artifactMIMEType in: query type: string description: Use type to describe an artifact - name: append in: query type: string description: Append files to an existing artifact - name: replace in: query type: string description: Replace an existing artifact with the same name outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-artifacts-pull path: /libpod/artifacts/pull operations: - name: artifactpulllibpod method: POST description: Pull an artifact inputParameters: - name: name in: query type: string required: true description: Mandatory reference to the artifact (e.g., quay.io/image/artifact:tag) - name: retry in: query type: string description: Number of times to retry in case of failure when performing pull - name: retryDelay in: query type: string description: Delay between retries in case of pull failures (e.g., 10s) - name: tlsVerify in: query type: string description: Require TLS verification - name: X-Registry-Auth in: header type: string description: 'base-64 encoded auth config. Must include the following four values: username, password, email and server address OR simply just an identity token.' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-artifacts-remove path: /libpod/artifacts/remove operations: - name: artifactdeletealllibpod method: DELETE description: Remove one or more artifacts inputParameters: - name: artifacts in: query type: string description: List of artifact names/IDs to remove - name: all in: query type: string description: Remove all artifacts - name: ignore in: query type: string description: Ignore errors if artifact does not exist outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-build path: /libpod/build operations: - name: imagebuildlibpod 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: allplatforms in: query type: string description: Instead of building for a set of platforms specified using the platform option, inspect the build's base images, and build for all of the platforms that are ava - name: additionalbuildcontexts in: query type: string description: Additional build contexts for builds that require more than one context. Each additional context must be specified as a key-value pair in the format "name=value - 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: q in: query type: string description: Suppress verbose build output - name: compatvolumes in: query type: string description: Contents of volume locations to be modified on ADD or COPY only (As of Podman version v5.2) - name: createdannotation in: query type: string description: Add an "org.opencontainers.image.created" annotation to the image. (As of Podman version v5.6) - name: sourcedateepoch in: query type: string description: Timestamp to use for newly-added history entries and the image's creation date. (As of Podman version v5.6) - name: rewritetimestamp in: query type: string description: If sourcedateepoch is set, force new content added in layers to have timestamps no later than the sourcedateepoch date. (As of Podman version v5.6) - name: timestamp in: query type: string description: Timestamp to use for newly-added history entries, the image's creation date, and for new content added in layers. - name: inheritlabels in: query type: string description: Inherit the labels from the base image or base stages (As of Podman version v5.5) - name: inheritannotations in: query type: string description: Inherit the annotations from the base image or base stages (As of Podman version v5.6) - 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: 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: layerLabel in: query type: string description: Add an intermediate image *label* (e.g. label=*value*) to the intermediate image metadata. - name: layers in: query type: string description: Cache intermediate layers during build. (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]] (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) - name: httpproxy in: query type: string description: Inject http proxy environment variables into container (As of version 2.0.0) - name: unsetenv in: query type: string description: Unset environment variables from the final image. - name: unsetlabel in: query type: string description: Unset the image label, causing the label not to be inherited from the base image. - name: unsetannotation in: query type: string description: Unset the image annotation, causing the annotation not to be inherited from the base image. (As of Podman version v5.6) - name: volume in: query type: string description: Extra volumes that should be mounted in the build container. - name: manifest in: query type: string description: Add the image to the specified manifest list. Creates a manifest list if it does not exist. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-commit path: /libpod/commit operations: - name: imagecommitlibpod method: POST description: Commit inputParameters: - name: container in: query type: string required: true description: the name or ID of a container - name: author in: query type: string description: author of the image - name: changes in: query type: string 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: string description: pause the container before committing it - name: squash in: query type: string 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: string description: output from commit process - name: tag in: query type: string description: tag name for the created image outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-containers-name path: /libpod/containers/{name} operations: - name: containerdeletelibpod method: DELETE description: Delete container inputParameters: - name: name in: path type: string required: true description: the name or ID of the container - name: depend in: query type: string description: additionally remove containers that depend on the container to be removed - name: force in: query type: string description: force stop container if running - name: ignore in: query type: string description: ignore errors when the container to be removed does not existxo - name: timeout in: query type: string description: number of seconds to wait before killing container when force removing - name: v in: query type: string description: delete volumes outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-containers-name-archive path: /libpod/containers/{name}/archive operations: - name: containerarchivelibpod method: GET description: Copy 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 - name: rename in: query type: string description: JSON encoded map[string]string to translate paths outputRawFormat: json outputParameters: - name: result type: object value: $. - name: putcontainerarchivelibpod method: PUT description: Copy 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: pause in: query type: string description: pause the container while copying (defaults to true) outputRawFormat: json outputParameters: - name: result type: object value: $. - name: libpod-containers-name-attach path: /libpod/containers/{name}/attach operations: - name: containerattachlibpod 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: $. exposes: - type: rest port: 8080 namespace: podman-rest description: REST adapter for supports a RESTful API for the Libpod library. resources: - path: /auth name: systemauth operations: - method: POST name: systemauth description: Check auth configuration call: podman.systemauth outputParameters: - type: object mapping: $. - path: /build name: imagebuild operations: - method: POST name: imagebuild description: Build image call: podman.imagebuild outputParameters: - type: object mapping: $. - path: /commit name: imagecommit operations: - method: POST name: imagecommit description: New Image call: podman.imagecommit outputParameters: - type: object mapping: $. - path: /containers/{name} name: containerdelete operations: - method: DELETE name: containerdelete description: Remove a container call: podman.containerdelete with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/archive name: containerarchive operations: - method: GET name: containerarchive description: Get files from a container call: podman.containerarchive with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/archive name: putcontainerarchive operations: - method: PUT name: putcontainerarchive description: Put files into a container call: podman.putcontainerarchive with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/attach name: containerattach operations: - method: POST name: containerattach description: Attach to a container call: podman.containerattach with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/changes name: containerchanges operations: - method: GET name: containerchanges description: Report on changes to container's filesystem; adds, deletes or modifications. call: podman.containerchanges with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/exec name: containerexec operations: - method: POST name: containerexec description: Create an exec instance call: podman.containerexec with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/export name: containerexport operations: - method: GET name: containerexport description: Export a container call: podman.containerexport with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/json name: containerinspect operations: - method: GET name: containerinspect description: Inspect container call: podman.containerinspect with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/kill name: containerkill operations: - method: POST name: containerkill description: Kill container call: podman.containerkill with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/logs name: containerlogs operations: - method: GET name: containerlogs description: Get container logs call: podman.containerlogs with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/pause name: containerpause operations: - method: POST name: containerpause description: Pause container call: podman.containerpause with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/rename name: containerrename operations: - method: POST name: containerrename description: Rename an existing container call: podman.containerrename with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/resize name: containerresize operations: - method: POST name: containerresize description: Resize a container's TTY call: podman.containerresize with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/restart name: containerrestart operations: - method: POST name: containerrestart description: Restart container call: podman.containerrestart with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/start name: containerstart operations: - method: POST name: containerstart description: Start a container call: podman.containerstart with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/stats name: containerstats operations: - method: GET name: containerstats description: Get stats for a container call: podman.containerstats with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/stop name: containerstop operations: - method: POST name: containerstop description: Stop a container call: podman.containerstop with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/top name: containertop operations: - method: GET name: containertop description: List processes running inside a container call: podman.containertop with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/unpause name: containerunpause operations: - method: POST name: containerunpause description: Unpause container call: podman.containerunpause with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/update name: containerupdate operations: - method: POST name: containerupdate description: Update configuration of an existing container, allowing changes to resource limits call: podman.containerupdate with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/{name}/wait name: containerwait operations: - method: POST name: containerwait description: Wait on a container call: podman.containerwait with: name: rest.name outputParameters: - type: object mapping: $. - path: /containers/create name: containercreate operations: - method: POST name: containercreate description: Create a container call: podman.containercreate outputParameters: - type: object mapping: $. - path: /containers/json name: containerlist operations: - method: GET name: containerlist description: List containers call: podman.containerlist outputParameters: - type: object mapping: $. - path: /containers/prune name: containerprune operations: - method: POST name: containerprune description: Delete stopped containers call: podman.containerprune outputParameters: - type: object mapping: $. - path: /events name: systemevents operations: - method: GET name: systemevents description: Get events call: podman.systemevents outputParameters: - type: object mapping: $. - path: /exec/{id}/json name: execinspect operations: - method: GET name: execinspect description: Inspect an exec instance call: podman.execinspect with: id: rest.id outputParameters: - type: object mapping: $. - path: /exec/{id}/resize name: execresize operations: - method: POST name: execresize description: Resize an exec instance call: podman.execresize with: id: rest.id outputParameters: - type: object mapping: $. - path: /exec/{id}/start name: execstart operations: - method: POST name: execstart description: Start an exec instance call: podman.execstart with: id: rest.id outputParameters: - type: object mapping: $. - path: /images/{name} name: imagedelete operations: - method: DELETE name: imagedelete description: Remove Image call: podman.imagedelete with: name: rest.name outputParameters: - type: object mapping: $. - path: /images/{name}/get name: imageget operations: - method: GET name: imageget description: Export an image call: podman.imageget with: name: rest.name outputParameters: - type: object mapping: $. - path: /images/{name}/history name: imagehistory operations: - method: GET name: imagehistory description: History of an image call: podman.imagehistory with: name: rest.name outputParameters: - type: object mapping: $. - path: /images/{name}/json name: imageinspect operations: - method: GET name: imageinspect description: Inspect an image call: podman.imageinspect with: name: rest.name outputParameters: - type: object mapping: $. - path: /images/{name}/push name: imagepush operations: - method: POST name: imagepush description: Push Image call: podman.imagepush with: name: rest.name outputParameters: - type: object mapping: $. - path: /images/{name}/tag name: imagetag operations: - method: POST name: imagetag description: Tag an image call: podman.imagetag with: name: rest.name outputParameters: - type: object mapping: $. - path: /images/create name: imagecreate operations: - method: POST name: imagecreate description: Create an image call: podman.imagecreate outputParameters: - type: object mapping: $. - path: /images/get name: imagegetall operations: - method: GET name: imagegetall description: Export several images call: podman.imagegetall outputParameters: - type: object mapping: $. - path: /images/json name: imagelist operations: - method: GET name: imagelist description: List Images call: podman.imagelist outputParameters: - type: object mapping: $. - path: /images/load name: imageload operations: - method: POST name: imageload description: Import image call: podman.imageload outputParameters: - type: object mapping: $. - path: /images/prune name: imageprune operations: - method: POST name: imageprune description: Prune unused images call: podman.imageprune outputParameters: - type: object mapping: $. - path: /images/search name: imagesearch operations: - method: GET name: imagesearch description: Search images call: podman.imagesearch outputParameters: - type: object mapping: $. - path: /info name: systeminfo operations: - method: GET name: systeminfo description: Get info call: podman.systeminfo outputParameters: - type: object mapping: $. - path: /libpod/_ping name: systemping operations: - method: GET name: systemping description: Ping service call: podman.systemping outputParameters: - type: object mapping: $. - path: /libpod/artifacts/{name} name: artifactdeletelibpod operations: - method: DELETE name: artifactdeletelibpod description: Remove an artifact call: podman.artifactdeletelibpod with: name: rest.name outputParameters: - type: object mapping: $. - path: /libpod/artifacts/{name}/extract name: artifactextractlibpod operations: - method: GET name: artifactextractlibpod description: Extract an artifacts contents call: podman.artifactextractlibpod with: name: rest.name outputParameters: - type: object mapping: $. - path: /libpod/artifacts/{name}/json name: artifactinspectlibpod operations: - method: GET name: artifactinspectlibpod description: Inspect an artifact call: podman.artifactinspectlibpod with: name: rest.name outputParameters: - type: object mapping: $. - path: /libpod/artifacts/{name}/push name: artifactpushlibpod operations: - method: POST name: artifactpushlibpod description: Push an artifact call: podman.artifactpushlibpod with: name: rest.name outputParameters: - type: object mapping: $. - path: /libpod/artifacts/add name: artifactaddlibpod operations: - method: POST name: artifactaddlibpod description: Add a file as an artifact call: podman.artifactaddlibpod outputParameters: - type: object mapping: $. - path: /libpod/artifacts/json name: artifactlistlibpod operations: - method: GET name: artifactlistlibpod description: List artifacts call: podman.artifactlistlibpod outputParameters: - type: object mapping: $. - path: /libpod/artifacts/local/add name: artifactlocallibpod operations: - method: POST name: artifactlocallibpod description: Add a local file as an artifact call: podman.artifactlocallibpod outputParameters: - type: object mapping: $. - path: /libpod/artifacts/pull name: artifactpulllibpod operations: - method: POST name: artifactpulllibpod description: Pull an artifact call: podman.artifactpulllibpod outputParameters: - type: object mapping: $. - path: /libpod/artifacts/remove name: artifactdeletealllibpod operations: - method: DELETE name: artifactdeletealllibpod description: Remove one or more artifacts call: podman.artifactdeletealllibpod outputParameters: - type: object mapping: $. - path: /libpod/build name: imagebuildlibpod operations: - method: POST name: imagebuildlibpod description: Build image call: podman.imagebuildlibpod outputParameters: - type: object mapping: $. - path: /libpod/commit name: imagecommitlibpod operations: - method: POST name: imagecommitlibpod description: Commit call: podman.imagecommitlibpod outputParameters: - type: object mapping: $. - path: /libpod/containers/{name} name: containerdeletelibpod operations: - method: DELETE name: containerdeletelibpod description: Delete container call: podman.containerdeletelibpod with: name: rest.name outputParameters: - type: object mapping: $. - path: /libpod/containers/{name}/archive name: containerarchivelibpod operations: - method: GET name: containerarchivelibpod description: Copy files from a container call: podman.containerarchivelibpod with: name: rest.name outputParameters: - type: object mapping: $. - path: /libpod/containers/{name}/archive name: putcontainerarchivelibpod operations: - method: PUT name: putcontainerarchivelibpod description: Copy files into a container call: podman.putcontainerarchivelibpod with: name: rest.name outputParameters: - type: object mapping: $. - path: /libpod/containers/{name}/attach name: containerattachlibpod operations: - method: POST name: containerattachlibpod description: Attach to a container call: podman.containerattachlibpod with: name: rest.name outputParameters: - type: object mapping: $. - type: mcp port: 9090 namespace: podman-mcp transport: http description: MCP adapter for supports a RESTful API for the Libpod library for AI agent use. tools: - name: systemauth description: Check auth configuration hints: readOnly: false destructive: false idempotent: false call: podman.systemauth outputParameters: - type: object mapping: $. - name: imagebuild description: Build image hints: readOnly: false destructive: false idempotent: false call: podman.imagebuild with: dockerfile: tools.dockerfile t: tools.t extrahosts: tools.extrahosts nohosts: tools.nohosts remote: tools.remote retry: tools.retry retry-delay: tools.retry-delay q: tools.q nocache: tools.nocache cachefrom: tools.cachefrom pull: tools.pull rm: tools.rm forcerm: tools.forcerm memory: tools.memory memswap: tools.memswap cpushares: tools.cpushares cpusetcpus: tools.cpusetcpus cpuperiod: tools.cpuperiod cpuquota: tools.cpuquota buildargs: tools.buildargs shmsize: tools.shmsize squash: tools.squash save-stages: tools.save-stages stage-labels: tools.stage-labels labels: tools.labels networkmode: tools.networkmode platform: tools.platform target: tools.target outputs: tools.outputs inputParameters: - name: dockerfile 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 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 type: string description: TBD Extra hosts to add to /etc/hosts (As of version 1.xx) - name: nohosts type: string description: Not to create /etc/hosts when building the image - name: remote 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 type: string description: Number of times to retry in case of failure when performing push/pull. - name: retry-delay type: string description: Delay between retries in case of push/pull failures. - name: q type: string description: Suppress verbose build output - name: nocache type: string description: Do not use the cache when building the image (As of version 1.xx) - name: cachefrom type: string description: JSON array of images used to build cache resolution (As of version 1.xx) - name: pull type: string description: Attempt to pull the image even if an older image exists locally (As of version 1.xx) - name: rm type: string description: Remove intermediate containers after a successful build (As of version 1.xx) - name: forcerm type: string description: Always remove intermediate containers, even upon failure (As of version 1.xx) - name: memory 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 type: string description: MemorySwap limits the amount of memory and swap together (As of version 1.xx) - name: cpushares type: string description: CPUShares (relative weight (As of version 1.xx) - name: cpusetcpus type: string description: CPUSetCPUs in which to allow execution (0-3, 0,1) (As of version 1.xx) - name: cpuperiod type: string description: CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period (As of version 1.xx) - name: cpuquota type: string description: CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota (As of version 1.xx) - name: buildargs 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 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 type: string description: Silently ignored. Squash the resulting images layers into a single layer (As of version 1.xx) - name: save-stages 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 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 type: string description: JSON map of key, value pairs to set as labels on the new image (As of version 1.xx) - name: networkmode 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 type: string description: Platform format os[/arch[/variant]] Can be comma separated list for multi arch builds. (As of version 1.xx) - name: target type: string description: Target build stage (As of version 1.xx) - name: outputs type: string description: output configuration TBD (As of version 1.xx) outputParameters: - type: object mapping: $. - name: imagecommit description: New Image hints: readOnly: false destructive: false idempotent: false call: podman.imagecommit with: container: tools.container repo: tools.repo tag: tools.tag comment: tools.comment author: tools.author pause: tools.pause changes: tools.changes squash: tools.squash inputParameters: - name: container type: string description: the name or ID of a container - name: repo type: string description: the repository name for the created image - name: tag type: string description: tag name for the created image - name: comment type: string description: commit message - name: author type: string description: author of the image - name: pause type: string description: pause the container before committing it - name: changes type: string description: instructions to apply while committing in Dockerfile format - name: squash type: string description: squash newly built layers into a single new layer outputParameters: - type: object mapping: $. - name: containerdelete description: Remove a container hints: readOnly: false destructive: true idempotent: true call: podman.containerdelete with: name: tools.name force: tools.force v: tools.v link: tools.link ignore: tools.ignore depend: tools.depend timeout: tools.timeout volumes: tools.volumes inputParameters: - name: name type: string description: the name or ID of the container required: true - name: force type: string description: If the container is running, kill it before removing it. - name: v type: string description: Remove the volumes associated with the container. - name: link type: string description: not supported - name: ignore type: string description: Ignore if a specified container does not exist. - name: depend type: string description: Remove container dependencies. - name: timeout type: string description: Number of seconds to wait before forcibly stopping the container. - name: volumes type: string description: Remove anonymous volumes associated with the container. outputParameters: - type: object mapping: $. - name: containerarchive description: Get files from a container hints: readOnly: true destructive: false idempotent: true call: podman.containerarchive with: name: tools.name path: tools.path inputParameters: - name: name type: string description: container name or id required: true - name: path type: string description: Path to a directory in the container to extract required: true outputParameters: - type: object mapping: $. - name: putcontainerarchive description: Put files into a container hints: readOnly: false destructive: false idempotent: true call: podman.putcontainerarchive with: name: tools.name path: tools.path noOverwriteDirNonDir: tools.noOverwriteDirNonDir copyUIDGID: tools.copyUIDGID inputParameters: - name: name type: string description: container name or id required: true - name: path type: string description: Path to a directory in the container to extract required: true - name: noOverwriteDirNonDir 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 type: string description: copy UID/GID maps to the dest file or di (1 or true) outputParameters: - type: object mapping: $. - name: containerattach description: Attach to a container hints: readOnly: false destructive: false idempotent: false call: podman.containerattach with: name: tools.name detachKeys: tools.detachKeys logs: tools.logs stream: tools.stream stdout: tools.stdout stderr: tools.stderr stdin: tools.stdin inputParameters: - name: name type: string description: the name or ID of the container required: true - name: detachKeys type: string description: keys to use for detaching from the container - name: logs 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 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 type: string description: Attach to container STDOUT - name: stderr type: string description: Attach to container STDERR - name: stdin type: string description: Attach to container STDIN outputParameters: - type: object mapping: $. - name: containerchanges description: Report on changes to container's filesystem; adds, deletes or modifications. hints: readOnly: true destructive: false idempotent: true call: podman.containerchanges with: name: tools.name parent: tools.parent diffType: tools.diffType inputParameters: - name: name type: string description: the name or id of the container required: true - name: parent type: string description: specify a second layer which is used to compare against it instead of the parent layer - name: diffType type: string description: select what you want to match, default is all outputParameters: - type: object mapping: $. - name: containerexec description: Create an exec instance hints: readOnly: false destructive: false idempotent: false call: podman.containerexec with: name: tools.name inputParameters: - name: name type: string description: name of container required: true outputParameters: - type: object mapping: $. - name: containerexport description: Export a container hints: readOnly: true destructive: false idempotent: true call: podman.containerexport with: name: tools.name inputParameters: - name: name type: string description: the name or ID of the container required: true outputParameters: - type: object mapping: $. - name: containerinspect description: Inspect container hints: readOnly: true destructive: false idempotent: true call: podman.containerinspect with: name: tools.name size: tools.size inputParameters: - name: name type: string description: the name or id of the container required: true - name: size type: string description: include the size of the container outputParameters: - type: object mapping: $. - name: containerkill description: Kill container hints: readOnly: false destructive: false idempotent: false call: podman.containerkill with: name: tools.name all: tools.all signal: tools.signal inputParameters: - name: name type: string description: the name or ID of the container required: true - name: all type: string description: Send kill signal to all containers - name: signal type: string description: signal to be sent to container outputParameters: - type: object mapping: $. - name: containerlogs description: Get container logs hints: readOnly: true destructive: false idempotent: true call: podman.containerlogs with: name: tools.name follow: tools.follow stdout: tools.stdout stderr: tools.stderr since: tools.since until: tools.until timestamps: tools.timestamps tail: tools.tail inputParameters: - name: name type: string description: the name or ID of the container required: true - name: follow type: string description: Keep connection after returning logs. - name: stdout type: string description: Return logs from stdout - name: stderr type: string description: Return logs from stderr - name: since type: string description: Only return logs since this time, as a UNIX timestamp - name: until type: string description: Only return logs before this time, as a UNIX timestamp - name: timestamps type: string description: Add timestamps to every log line - name: tail type: string description: Only return this number of log lines from the end of the logs outputParameters: - type: object mapping: $. - name: containerpause description: Pause container hints: readOnly: false destructive: false idempotent: false call: podman.containerpause with: name: tools.name inputParameters: - name: name type: string description: the name or ID of the container required: true outputParameters: - type: object mapping: $. - name: containerrename description: Rename an existing container hints: readOnly: false destructive: false idempotent: false call: podman.containerrename with: name: tools.name inputParameters: - name: name type: string description: Full or partial ID or full name of the container to rename required: true - name: name type: string description: New name for the container required: true outputParameters: - type: object mapping: $. - name: containerresize description: Resize a container's TTY hints: readOnly: false destructive: false idempotent: false call: podman.containerresize with: name: tools.name h: tools.h w: tools.w running: tools.running inputParameters: - name: name type: string description: the name or ID of the container required: true - name: h type: string description: Height to set for the terminal, in characters - name: w type: string description: Width to set for the terminal, in characters - name: running type: string description: Ignore containers not running errors outputParameters: - type: object mapping: $. - name: containerrestart description: Restart container hints: readOnly: false destructive: false idempotent: false call: podman.containerrestart with: name: tools.name t: tools.t inputParameters: - name: name type: string description: the name or ID of the container required: true - name: t type: string description: timeout before sending kill signal to container outputParameters: - type: object mapping: $. - name: containerstart description: Start a container hints: readOnly: false destructive: false idempotent: false call: podman.containerstart with: name: tools.name detachKeys: tools.detachKeys inputParameters: - name: name type: string description: the name or ID of the container required: true - name: detachKeys type: string description: 'Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl- where is one of: a-z, @, ^, [, , or _.' outputParameters: - type: object mapping: $. - name: containerstats description: Get stats for a container hints: readOnly: true destructive: false idempotent: true call: podman.containerstats with: name: tools.name stream: tools.stream one-shot: tools.one-shot inputParameters: - name: name type: string description: the name or ID of the container required: true - name: stream type: string description: Stream the output - name: one-shot type: string description: Provide a one-shot response in which preCPU stats are blank, resulting in a single cycle return. outputParameters: - type: object mapping: $. - name: containerstop description: Stop a container hints: readOnly: false destructive: false idempotent: false call: podman.containerstop with: name: tools.name t: tools.t timeout: tools.timeout ignore: tools.ignore inputParameters: - name: name type: string description: the name or ID of the container required: true - name: t type: string description: number of seconds to wait before killing container - name: timeout type: string description: Number of seconds to wait before killing the container (libpod alias for `t`). - name: ignore type: string description: Do not return an error if the container is already stopped. outputParameters: - type: object mapping: $. - name: containertop description: List processes running inside a container hints: readOnly: true destructive: false idempotent: true call: podman.containertop with: name: tools.name ps_args: tools.ps_args inputParameters: - name: name type: string description: the name or ID of the container required: true - name: ps_args type: string description: arguments to pass to ps such as aux. outputParameters: - type: object mapping: $. - name: containerunpause description: Unpause container hints: readOnly: false destructive: false idempotent: false call: podman.containerunpause with: name: tools.name inputParameters: - name: name type: string description: the name or ID of the container required: true outputParameters: - type: object mapping: $. - name: containerupdate description: Update configuration of an existing container, allowing changes to resource limits hints: readOnly: false destructive: false idempotent: false call: podman.containerupdate with: name: tools.name inputParameters: - name: name type: string description: Full or partial ID or full name of the container to rename required: true outputParameters: - type: object mapping: $. - name: containerwait description: Wait on a container hints: readOnly: false destructive: false idempotent: false call: podman.containerwait with: name: tools.name condition: tools.condition inputParameters: - name: name type: string description: the name or ID of the container required: true - name: condition 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' outputParameters: - type: object mapping: $. - name: containercreate description: Create a container hints: readOnly: false destructive: false idempotent: false call: podman.containercreate with: name: tools.name inputParameters: - name: name type: string description: container name outputParameters: - type: object mapping: $. - name: containerlist description: List containers hints: readOnly: true destructive: false idempotent: true call: podman.containerlist with: all: tools.all external: tools.external limit: tools.limit size: tools.size filters: tools.filters inputParameters: - name: all type: string description: Return all containers. By default, only running containers are shown - name: external type: string description: Return containers in storage not controlled by Podman - name: limit type: string description: Return this number of most recently created containers, including non-running ones. - name: size type: string description: Return the size of container as fields SizeRw and SizeRootFs. - name: filters type: string description: 'A JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters: - `ancestor`=(`[:]`, `` Prune containers created before this t' outputParameters: - type: object mapping: $. - name: systemevents description: Get events hints: readOnly: true destructive: false idempotent: true call: podman.systemevents with: since: tools.since until: tools.until filters: tools.filters inputParameters: - name: since type: string description: start streaming events from this time - name: until type: string description: stop streaming events later than this - name: filters type: string description: JSON encoded map[string][]string of constraints outputParameters: - type: object mapping: $. - name: execinspect description: Inspect an exec instance hints: readOnly: true destructive: false idempotent: true call: podman.execinspect with: id: tools.id inputParameters: - name: id type: string description: Exec instance ID required: true outputParameters: - type: object mapping: $. - name: execresize description: Resize an exec instance hints: readOnly: false destructive: false idempotent: false call: podman.execresize with: id: tools.id h: tools.h w: tools.w running: tools.running inputParameters: - name: id type: string description: Exec instance ID required: true - name: h type: string description: Height of the TTY session in characters - name: w type: string description: Width of the TTY session in characters - name: running type: string description: Ignore containers not running errors outputParameters: - type: object mapping: $. - name: execstart description: Start an exec instance hints: readOnly: false destructive: false idempotent: false call: podman.execstart with: id: tools.id inputParameters: - name: id type: string description: Exec instance ID required: true outputParameters: - type: object mapping: $. - name: imagedelete description: Remove Image hints: readOnly: false destructive: true idempotent: true call: podman.imagedelete with: name: tools.name force: tools.force noprune: tools.noprune ignore: tools.ignore inputParameters: - name: name type: string description: name or ID of image to delete required: true - name: force type: string description: Remove the image even if it is being used by stopped containers or has other tags - name: noprune type: string description: do not remove dangling parent images - name: ignore type: string description: Ignore if a specified image does not exist and do not throw an error. outputParameters: - type: object mapping: $. - name: imageget description: Export an image hints: readOnly: true destructive: false idempotent: true call: podman.imageget with: name: tools.name inputParameters: - name: name type: string description: the name or ID of the container required: true outputParameters: - type: object mapping: $. - name: imagehistory description: History of an image hints: readOnly: true destructive: false idempotent: true call: podman.imagehistory with: name: tools.name inputParameters: - name: name type: string description: the name or ID of the container required: true outputParameters: - type: object mapping: $. - name: imageinspect description: Inspect an image hints: readOnly: true destructive: false idempotent: true call: podman.imageinspect with: name: tools.name inputParameters: - name: name type: string description: the name or ID of the container required: true outputParameters: - type: object mapping: $. - name: imagepush description: Push Image hints: readOnly: false destructive: false idempotent: false call: podman.imagepush with: name: tools.name tag: tools.tag all: tools.all compress: tools.compress destination: tools.destination format: tools.format tlsVerify: tools.tlsVerify inputParameters: - name: name type: string description: Name of image to push. required: true - name: tag type: string description: The tag to associate with the image on the registry. - name: all type: string description: All indicates whether to push all images related to the image list - name: compress type: string description: Use compression on image. - name: destination type: string description: Allows for pushing the image to a different destination than the image refers to. - name: format 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 type: string description: Require TLS verification. outputParameters: - type: object mapping: $. - name: imagetag description: Tag an image hints: readOnly: false destructive: false idempotent: false call: podman.imagetag with: name: tools.name repo: tools.repo tag: tools.tag inputParameters: - name: name type: string description: the name or ID of the container required: true - name: repo type: string description: the repository to tag in - name: tag type: string description: the name of the new tag outputParameters: - type: object mapping: $. - name: imagecreate description: Create an image hints: readOnly: false destructive: false idempotent: false call: podman.imagecreate with: fromImage: tools.fromImage fromSrc: tools.fromSrc repo: tools.repo tag: tools.tag message: tools.message platform: tools.platform retry: tools.retry retryDelay: tools.retryDelay inputParameters: - name: fromImage type: string description: Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connec - name: fromSrc type: string description: Source to import. The value may be a URL from which the image can be retrieved or - to read the image from the request body. This parameter may only be used whe - name: repo type: string description: Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image. - name: tag type: string description: Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. - name: message type: string description: Set commit message for imported image. - name: platform type: string description: Platform in the format os[/arch[/variant]] - name: retry type: string description: Number of times to retry in case of failure when performing pull. - name: retryDelay type: string description: Delay between retries in case of pull failures. outputParameters: - type: object mapping: $. - name: imagegetall description: Export several images hints: readOnly: true destructive: false idempotent: true call: podman.imagegetall with: names: tools.names inputParameters: - name: names type: string description: one or more image names or IDs comma separated required: true outputParameters: - type: object mapping: $. - name: imagelist description: List Images hints: readOnly: true destructive: false idempotent: true call: podman.imagelist with: all: tools.all filters: tools.filters digests: tools.digests shared-size: tools.shared-size inputParameters: - name: all type: string description: Show all images. Only images from a final layer (no children) are shown by default. - name: filters type: string description: 'JSON-encoded string containing filters as a `map[string][]string` to process on the images list. Available filters: - `before`=(`[:]`, `` When set to `true` (or `1`), prune only unus' outputParameters: - type: object mapping: $. - name: imagesearch description: Search images hints: readOnly: true destructive: false idempotent: true call: podman.imagesearch with: term: tools.term limit: tools.limit filters: tools.filters tlsVerify: tools.tlsVerify listTags: tools.listTags inputParameters: - name: term type: string description: term to search - name: limit type: string description: maximum number of results - name: filters type: string description: 'JSON-encoded string containing filters as a `map[string][]string` to process on the images list. Available filters: - `is-automated=(true|false)` - `is-official' - name: tlsVerify type: string description: Require HTTPS and verify signatures when contacting registries. - name: listTags type: string description: list the available tags in the repository outputParameters: - type: object mapping: $. - name: systeminfo description: Get info hints: readOnly: true destructive: false idempotent: true call: podman.systeminfo outputParameters: - type: object mapping: $. - name: systemping description: Ping service hints: readOnly: true destructive: false idempotent: true call: podman.systemping outputParameters: - type: object mapping: $. - name: artifactdeletelibpod description: Remove an artifact hints: readOnly: false destructive: true idempotent: true call: podman.artifactdeletelibpod with: name: tools.name inputParameters: - name: name type: string description: Name or ID of the artifact to remove required: true outputParameters: - type: object mapping: $. - name: artifactextractlibpod description: Extract an artifacts contents hints: readOnly: true destructive: false idempotent: true call: podman.artifactextractlibpod with: name: tools.name title: tools.title digest: tools.digest excludeTitle: tools.excludeTitle inputParameters: - name: name type: string description: Name or digest of the artifact required: true - name: title type: string description: Only extract the file with the given title - name: digest type: string description: Only extract the file with the given digest - name: excludeTitle type: string description: When extracting a single file from an artifact, don't use the files title as the file name in the tar archive outputParameters: - type: object mapping: $. - name: artifactinspectlibpod description: Inspect an artifact hints: readOnly: true destructive: false idempotent: true call: podman.artifactinspectlibpod with: name: tools.name inputParameters: - name: name type: string description: Name or ID of the artifact required: true outputParameters: - type: object mapping: $. - name: artifactpushlibpod description: Push an artifact hints: readOnly: false destructive: false idempotent: false call: podman.artifactpushlibpod with: name: tools.name retry: tools.retry retryDelay: tools.retryDelay tlsVerify: tools.tlsVerify inputParameters: - name: name type: string description: Mandatory reference to the artifact (e.g., quay.io/image/artifact:tag) required: true - name: retry type: string description: Number of times to retry in case of failure when performing pull - name: retryDelay type: string description: Delay between retries in case of pull failures (e.g., 10s) - name: tlsVerify type: string description: Require TLS verification outputParameters: - type: object mapping: $. - name: artifactaddlibpod description: Add a file as an artifact hints: readOnly: false destructive: false idempotent: false call: podman.artifactaddlibpod with: name: tools.name fileName: tools.fileName fileMIMEType: tools.fileMIMEType annotations: tools.annotations artifactMIMEType: tools.artifactMIMEType append: tools.append replace: tools.replace inputParameters: - name: name type: string description: Mandatory reference to the artifact (e.g., quay.io/image/artifact:tag) required: true - name: fileName type: string description: Path of the file to be added required: true - name: fileMIMEType type: string description: Optionally set the type of file - name: annotations type: string description: Array of annotation strings e.g "test=true" - name: artifactMIMEType type: string description: Use type to describe an artifact - name: append type: string description: Append files to an existing artifact - name: replace type: string description: Replace an existing artifact with the same name outputParameters: - type: object mapping: $. - name: artifactlistlibpod description: List artifacts hints: readOnly: true destructive: false idempotent: true call: podman.artifactlistlibpod outputParameters: - type: object mapping: $. - name: artifactlocallibpod description: Add a local file as an artifact hints: readOnly: false destructive: false idempotent: false call: podman.artifactlocallibpod with: name: tools.name path: tools.path fileName: tools.fileName fileMIMEType: tools.fileMIMEType annotations: tools.annotations artifactMIMEType: tools.artifactMIMEType append: tools.append replace: tools.replace inputParameters: - name: name type: string description: Mandatory reference to the artifact (e.g., quay.io/image/artifact:tag) required: true - name: path type: string description: Absolute path to the local file on the server filesystem to be added required: true - name: fileName type: string description: Name/title of the file within the artifact required: true - name: fileMIMEType type: string description: Optionally set the MIME type of the file - name: annotations type: string description: Array of annotation strings e.g "test=true" - name: artifactMIMEType type: string description: Use type to describe an artifact - name: append type: string description: Append files to an existing artifact - name: replace type: string description: Replace an existing artifact with the same name outputParameters: - type: object mapping: $. - name: artifactpulllibpod description: Pull an artifact hints: readOnly: false destructive: false idempotent: false call: podman.artifactpulllibpod with: name: tools.name retry: tools.retry retryDelay: tools.retryDelay tlsVerify: tools.tlsVerify inputParameters: - name: name type: string description: Mandatory reference to the artifact (e.g., quay.io/image/artifact:tag) required: true - name: retry type: string description: Number of times to retry in case of failure when performing pull - name: retryDelay type: string description: Delay between retries in case of pull failures (e.g., 10s) - name: tlsVerify type: string description: Require TLS verification outputParameters: - type: object mapping: $. - name: artifactdeletealllibpod description: Remove one or more artifacts hints: readOnly: false destructive: true idempotent: true call: podman.artifactdeletealllibpod with: artifacts: tools.artifacts all: tools.all ignore: tools.ignore inputParameters: - name: artifacts type: string description: List of artifact names/IDs to remove - name: all type: string description: Remove all artifacts - name: ignore type: string description: Ignore errors if artifact does not exist outputParameters: - type: object mapping: $. - name: imagebuildlibpod description: Build image hints: readOnly: false destructive: false idempotent: false call: podman.imagebuildlibpod with: dockerfile: tools.dockerfile t: tools.t allplatforms: tools.allplatforms additionalbuildcontexts: tools.additionalbuildcontexts extrahosts: tools.extrahosts nohosts: tools.nohosts remote: tools.remote q: tools.q compatvolumes: tools.compatvolumes createdannotation: tools.createdannotation sourcedateepoch: tools.sourcedateepoch rewritetimestamp: tools.rewritetimestamp timestamp: tools.timestamp inheritlabels: tools.inheritlabels inheritannotations: tools.inheritannotations nocache: tools.nocache cachefrom: tools.cachefrom pull: tools.pull rm: tools.rm forcerm: tools.forcerm memory: tools.memory memswap: tools.memswap cpushares: tools.cpushares cpusetcpus: tools.cpusetcpus cpuperiod: tools.cpuperiod cpuquota: tools.cpuquota buildargs: tools.buildargs shmsize: tools.shmsize squash: tools.squash labels: tools.labels layerLabel: tools.layerLabel layers: tools.layers networkmode: tools.networkmode platform: tools.platform target: tools.target outputs: tools.outputs httpproxy: tools.httpproxy unsetenv: tools.unsetenv unsetlabel: tools.unsetlabel unsetannotation: tools.unsetannotation volume: tools.volume manifest: tools.manifest inputParameters: - name: dockerfile 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 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: allplatforms type: string description: Instead of building for a set of platforms specified using the platform option, inspect the build's base images, and build for all of the platforms that are ava - name: additionalbuildcontexts type: string description: Additional build contexts for builds that require more than one context. Each additional context must be specified as a key-value pair in the format "name=value - name: extrahosts type: string description: TBD Extra hosts to add to /etc/hosts (As of version 1.xx) - name: nohosts type: string description: Not to create /etc/hosts when building the image - name: remote 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: q type: string description: Suppress verbose build output - name: compatvolumes type: string description: Contents of volume locations to be modified on ADD or COPY only (As of Podman version v5.2) - name: createdannotation type: string description: Add an "org.opencontainers.image.created" annotation to the image. (As of Podman version v5.6) - name: sourcedateepoch type: string description: Timestamp to use for newly-added history entries and the image's creation date. (As of Podman version v5.6) - name: rewritetimestamp type: string description: If sourcedateepoch is set, force new content added in layers to have timestamps no later than the sourcedateepoch date. (As of Podman version v5.6) - name: timestamp type: string description: Timestamp to use for newly-added history entries, the image's creation date, and for new content added in layers. - name: inheritlabels type: string description: Inherit the labels from the base image or base stages (As of Podman version v5.5) - name: inheritannotations type: string description: Inherit the annotations from the base image or base stages (As of Podman version v5.6) - name: nocache type: string description: Do not use the cache when building the image (As of version 1.xx) - name: cachefrom type: string description: JSON array of images used to build cache resolution (As of version 1.xx) - name: pull type: string description: Attempt to pull the image even if an older image exists locally (As of version 1.xx) - name: rm type: string description: Remove intermediate containers after a successful build (As of version 1.xx) - name: forcerm type: string description: Always remove intermediate containers, even upon failure (As of version 1.xx) - name: memory 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 type: string description: MemorySwap limits the amount of memory and swap together (As of version 1.xx) - name: cpushares type: string description: CPUShares (relative weight (As of version 1.xx) - name: cpusetcpus type: string description: CPUSetCPUs in which to allow execution (0-3, 0,1) (As of version 1.xx) - name: cpuperiod type: string description: CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period (As of version 1.xx) - name: cpuquota type: string description: CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota (As of version 1.xx) - name: buildargs 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 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 type: string description: Silently ignored. Squash the resulting images layers into a single layer (As of version 1.xx) - name: labels type: string description: JSON map of key, value pairs to set as labels on the new image (As of version 1.xx) - name: layerLabel type: string description: Add an intermediate image *label* (e.g. label=*value*) to the intermediate image metadata. - name: layers type: string description: Cache intermediate layers during build. (As of version 1.xx) - name: networkmode 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 type: string description: Platform format os[/arch[/variant]] (As of version 1.xx) - name: target type: string description: Target build stage (As of version 1.xx) - name: outputs type: string description: output configuration TBD (As of version 1.xx) - name: httpproxy type: string description: Inject http proxy environment variables into container (As of version 2.0.0) - name: unsetenv type: string description: Unset environment variables from the final image. - name: unsetlabel type: string description: Unset the image label, causing the label not to be inherited from the base image. - name: unsetannotation type: string description: Unset the image annotation, causing the annotation not to be inherited from the base image. (As of Podman version v5.6) - name: volume type: string description: Extra volumes that should be mounted in the build container. - name: manifest type: string description: Add the image to the specified manifest list. Creates a manifest list if it does not exist. outputParameters: - type: object mapping: $. - name: imagecommitlibpod description: Commit hints: readOnly: false destructive: false idempotent: false call: podman.imagecommitlibpod with: container: tools.container author: tools.author changes: tools.changes comment: tools.comment format: tools.format pause: tools.pause squash: tools.squash repo: tools.repo stream: tools.stream tag: tools.tag inputParameters: - name: container type: string description: the name or ID of a container required: true - name: author type: string description: author of the image - name: changes type: string description: instructions to apply while committing in Dockerfile format (i.e. "CMD=/bin/foo") - name: comment type: string description: commit message - name: format type: string description: format of the image manifest and metadata (default "oci") - name: pause type: string description: pause the container before committing it - name: squash type: string description: squash the container before committing it - name: repo type: string description: the repository name for the created image - name: stream type: string description: output from commit process - name: tag type: string description: tag name for the created image outputParameters: - type: object mapping: $. - name: containerdeletelibpod description: Delete container hints: readOnly: false destructive: true idempotent: true call: podman.containerdeletelibpod with: name: tools.name depend: tools.depend force: tools.force ignore: tools.ignore timeout: tools.timeout v: tools.v inputParameters: - name: name type: string description: the name or ID of the container required: true - name: depend type: string description: additionally remove containers that depend on the container to be removed - name: force type: string description: force stop container if running - name: ignore type: string description: ignore errors when the container to be removed does not existxo - name: timeout type: string description: number of seconds to wait before killing container when force removing - name: v type: string description: delete volumes outputParameters: - type: object mapping: $. - name: containerarchivelibpod description: Copy files from a container hints: readOnly: true destructive: false idempotent: true call: podman.containerarchivelibpod with: name: tools.name path: tools.path rename: tools.rename inputParameters: - name: name type: string description: container name or id required: true - name: path type: string description: Path to a directory in the container to extract required: true - name: rename type: string description: JSON encoded map[string]string to translate paths outputParameters: - type: object mapping: $. - name: putcontainerarchivelibpod description: Copy files into a container hints: readOnly: false destructive: false idempotent: true call: podman.putcontainerarchivelibpod with: name: tools.name path: tools.path pause: tools.pause inputParameters: - name: name type: string description: container name or id required: true - name: path type: string description: Path to a directory in the container to extract required: true - name: pause type: string description: pause the container while copying (defaults to true) outputParameters: - type: object mapping: $. - name: containerattachlibpod description: Attach to a container hints: readOnly: false destructive: false idempotent: false call: podman.containerattachlibpod with: name: tools.name detachKeys: tools.detachKeys logs: tools.logs stream: tools.stream stdout: tools.stdout stderr: tools.stderr stdin: tools.stdin inputParameters: - name: name type: string description: the name or ID of the container required: true - name: detachKeys type: string description: keys to use for detaching from the container - name: logs 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 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 type: string description: Attach to container STDOUT - name: stderr type: string description: Attach to container STDERR - name: stdin type: string description: Attach to container STDIN outputParameters: - type: object mapping: $.