{ "opencollection": "1.0.0", "info": { "name": "supports a RESTful API for the Libpod library artifacts images API", "version": "5.0.0" }, "items": [ { "info": { "name": "images", "type": "folder" }, "items": [ { "info": { "name": "Build image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/build", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "X-Registry-Config", "value": "" } ], "params": [ { "name": "dockerfile", "value": "", "type": "query", "description": "Path within the build context to the `Dockerfile`.\nThis is ignored if remote is specified and points to an external `Dockerfile`.\n" }, { "name": "t", "value": "", "type": "query", "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 parameters." }, { "name": "allplatforms", "value": "", "type": "query", "description": "Instead of building for a set of platforms specified using the platform option, inspect the build's base images,\nand build for all of the platforms that are available. Stages that use *scratch* as a starting point can not be inspected,\nso at least one non-*scratch* stage must be present for detection to work usefully.\n" }, { "name": "additionalbuildcontexts", "value": "", "type": "query", "description": "Additional build contexts for builds that require more than one context.\nEach additional context must be specified as a key-value pair in the format \"name=value\".\n\nThe value can be specified in two formats:\n- URL context: Use the prefix \"url:\" followed by a URL to a tar archive\n Example: \"mycontext=url:https://example.com/context.tar\"\n- Image context: Use the prefix \"image:\" followed by an image reference\n Example: \"mycontext=image:alpine:latest\" or \"mycontext=image:docker.io/library/ubuntu:22.04\"\n\nLocal contexts are provided via multipart/form-data upload. When using multipart/form-data,\ninclude additional build contexts as separate form fields with names prefixed by \"build-context-\".\nFor example, a local context named \"mycontext\" should be uploaded as a tar file in a field\nnamed \"build-context-mycontext\".\n\n(As of version 5.6.0)\n" }, { "name": "extrahosts", "value": "", "type": "query", "description": "TBD Extra hosts to add to /etc/hosts\n(As of version 1.xx)\n" }, { "name": "nohosts", "value": "", "type": "query", "description": "Not to create /etc/hosts when building the image\n" }, { "name": "remote", "value": "", "type": "query", "description": "A Git repository URI or HTTP/HTTPS context URI.\nIf the URI points to a single text file, the file’s contents are placed\ninto a file called Dockerfile and the image is built from that file. If\nthe URI points to a tarball, the file is downloaded by the daemon and the\ncontents therein used as the context for the build. If the URI points to a\ntarball and the dockerfile parameter is also specified, there must be a file\nwith the corresponding path inside the tarball.\n(As of version 1.xx)\n" }, { "name": "q", "value": "", "type": "query", "description": "Suppress verbose build output\n" }, { "name": "compatvolumes", "value": "", "type": "query", "description": "Contents of volume locations to be modified on ADD or COPY only\n(As of Podman version v5.2)\n" }, { "name": "createdannotation", "value": "", "type": "query", "description": "Add an \"org.opencontainers.image.created\" annotation to the\nimage.\n(As of Podman version v5.6)\n" }, { "name": "sourcedateepoch", "value": "", "type": "query", "description": "Timestamp to use for newly-added history entries and the image's\ncreation date.\n(As of Podman version v5.6)\n" }, { "name": "rewritetimestamp", "value": "", "type": "query", "description": "If sourcedateepoch is set, force new content added in layers to\nhave timestamps no later than the sourcedateepoch date.\n(As of Podman version v5.6)\n" }, { "name": "timestamp", "value": "", "type": "query", "description": "Timestamp to use for newly-added history entries, the image's\ncreation date, and for new content added in layers.\n" }, { "name": "inheritlabels", "value": "", "type": "query", "description": "Inherit the labels from the base image or base stages\n(As of Podman version v5.5)\n" }, { "name": "inheritannotations", "value": "", "type": "query", "description": "Inherit the annotations from the base image or base stages\n(As of Podman version v5.6)\n" }, { "name": "nocache", "value": "", "type": "query", "description": "Do not use the cache when building the image\n(As of version 1.xx)\n" }, { "name": "cachefrom", "value": "", "type": "query", "description": "JSON array of images used to build cache resolution\n(As of version 1.xx)\n" }, { "name": "pull", "value": "", "type": "query", "description": "Attempt to pull the image even if an older image exists locally\n(As of version 1.xx)\n" }, { "name": "rm", "value": "", "type": "query", "description": "Remove intermediate containers after a successful build\n(As of version 1.xx)\n" }, { "name": "forcerm", "value": "", "type": "query", "description": "Always remove intermediate containers, even upon failure\n(As of version 1.xx)\n" }, { "name": "memory", "value": "", "type": "query", "description": "Memory is the upper limit (in bytes) on how much memory running containers can use\n(As of version 1.xx)\n" }, { "name": "memswap", "value": "", "type": "query", "description": "MemorySwap limits the amount of memory and swap together\n(As of version 1.xx)\n" }, { "name": "cpushares", "value": "", "type": "query", "description": "CPUShares (relative weight\n(As of version 1.xx)\n" }, { "name": "cpusetcpus", "value": "", "type": "query", "description": "CPUSetCPUs in which to allow execution (0-3, 0,1)\n(As of version 1.xx)\n" }, { "name": "cpuperiod", "value": "", "type": "query", "description": "CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period\n(As of version 1.xx)\n" }, { "name": "cpuquota", "value": "", "type": "query", "description": "CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota\n(As of version 1.xx)\n" }, { "name": "buildargs", "value": "", "type": "query", "description": "JSON map of string pairs denoting build-time variables.\nFor example, the build argument `Foo` with the value of `bar` would be encoded in JSON as `[\"Foo\":\"bar\"]`.\n\nFor example, buildargs={\"Foo\":\"bar\"}.\n\nNote(s):\n* This should not be used to pass secrets.\n* The value of buildargs should be URI component encoded before being passed to the API.\n\n(As of version 1.xx)\n" }, { "name": "shmsize", "value": "", "type": "query", "description": "ShmSize is the \"size\" value to use when mounting an shmfs on the container's /dev/shm directory.\nDefault is 64MB\n(As of version 1.xx)\n" }, { "name": "squash", "value": "", "type": "query", "description": "Silently ignored.\nSquash the resulting images layers into a single layer\n(As of version 1.xx)\n" }, { "name": "labels", "value": "", "type": "query", "description": "JSON map of key, value pairs to set as labels on the new image\n(As of version 1.xx)\n" }, { "name": "layerLabel", "value": "", "type": "query", "description": "Add an intermediate image *label* (e.g. label=*value*) to the intermediate image metadata." }, { "name": "layers", "value": "", "type": "query", "description": "Cache intermediate layers during build.\n(As of version 1.xx)\n" }, { "name": "networkmode", "value": "", "type": "query", "description": "Sets the networking mode for the run commands during build.\nSupported standard values are:\n * `bridge` limited to containers within a single host, port mapping required for external access\n * `host` no isolation between host and containers on this network\n * `none` disable all networking for this container\n * container: share networking with given container\n ---All other values are assumed to be a custom network's name\n(As of version 1.xx)\n" }, { "name": "platform", "value": "", "type": "query", "description": "Platform format os[/arch[/variant]]\n(As of version 1.xx)\n" }, { "name": "target", "value": "", "type": "query", "description": "Target build stage\n(As of version 1.xx)\n" }, { "name": "outputs", "value": "", "type": "query", "description": "output configuration TBD\n(As of version 1.xx)\n" }, { "name": "httpproxy", "value": "", "type": "query", "description": "Inject http proxy environment variables into container\n(As of version 2.0.0)\n" }, { "name": "unsetenv", "value": "", "type": "query", "description": "Unset environment variables from the final image." }, { "name": "unsetlabel", "value": "", "type": "query", "description": "Unset the image label, causing the label not to be inherited from the base image." }, { "name": "unsetannotation", "value": "", "type": "query", "description": "Unset the image annotation, causing the annotation not to be inherited from the base image.\n(As of Podman version v5.6)\n" }, { "name": "volume", "value": "", "type": "query", "description": "Extra volumes that should be mounted in the build container." }, { "name": "manifest", "value": "", "type": "query", "description": "Add the image to the specified manifest list. Creates a manifest list if it does not exist.\n" } ] }, "docs": "Build an image from the given Dockerfile(s)" }, { "info": { "name": "Remove an image from the local storage.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/libpod/images/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name or ID of image to remove" }, { "name": "force", "value": "", "type": "query", "description": "remove the image even if used by containers or has other tags" }, { "name": "ignore", "value": "", "type": "query", "description": "Ignore if a specified image does not exist and do not throw an error." }, { "name": "lookupManifest", "value": "", "type": "query", "description": "Resolve to a manifest list instead of an image." } ] }, "docs": "Remove an image from the local storage." }, { "info": { "name": "Report on changes to images's filesystem; adds, deletes or modifications.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/libpod/images/:name/changes", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name or id of the image" }, { "name": "parent", "value": "", "type": "query", "description": "specify a second layer which is used to compare against it instead of the parent layer" }, { "name": "diffType", "value": "", "type": "query", "description": "select what you want to match, default is all" } ] }, "docs": "Returns which files in an image's filesystem have been added, deleted, or modified. The Kind of modification can be one of:\n\n0: Modified\n1: Added\n2: Deleted\n" }, { "info": { "name": "Image exists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/libpod/images/:name/exists", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name or ID of the container" } ] }, "docs": "Check if image exists in local store" }, { "info": { "name": "Export an image", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/libpod/images/:name/get", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name or ID of the container" }, { "name": "format", "value": "", "type": "query", "description": "format for exported image" }, { "name": "compress", "value": "", "type": "query", "description": "use compression on image" } ] }, "docs": "Export an image" }, { "info": { "name": "History of an image", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/libpod/images/:name/history", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name or ID of the container" } ] }, "docs": "Return parent layers of an image." }, { "info": { "name": "Inspect an image", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/libpod/images/:name/json", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name or ID of the container" } ] }, "docs": "Obtain low-level information about an image" }, { "info": { "name": "Push Image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/images/:name/push", "headers": [ { "name": "X-Registry-Auth", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of image to push." }, { "name": "destination", "value": "", "type": "query", "description": "Allows for pushing the image to a different destination than the image refers to." }, { "name": "forceCompressionFormat", "value": "", "type": "query", "description": "Enforce compressing the layers with the specified --compression and do not reuse differently compressed blobs on the registry." }, { "name": "compressionFormat", "value": "", "type": "query", "description": "Compression format used to compress image layers." }, { "name": "compressionLevel", "value": "", "type": "query", "description": "Compression level used to compress image layers." }, { "name": "tlsVerify", "value": "", "type": "query", "description": "Require TLS verification." }, { "name": "quiet", "value": "", "type": "query", "description": "Silences extra stream data on push." }, { "name": "format", "value": "", "type": "query", "description": "Manifest type (oci, v2s1, or v2s2) to use when pushing an image. Default is manifest type of source, with fallbacks." }, { "name": "all", "value": "", "type": "query", "description": "All indicates whether to push all images related to the image list." }, { "name": "removeSignatures", "value": "", "type": "query", "description": "Discard any pre-existing signatures in the image." }, { "name": "retry", "value": "", "type": "query", "description": "Number of times to retry push in case of failure." }, { "name": "retryDelay", "value": "", "type": "query", "description": "Delay between retries in case of push failures. Duration format such as \"412ms\", or \"3.5h\"." } ] }, "docs": "Push an image to a container registry" }, { "info": { "name": "Resolve an image (short) name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/libpod/images/:name/resolve", "params": [ { "name": "name", "value": "", "type": "path", "description": "the (short) name to resolve" } ] }, "docs": "Resolve the passed image name to a list of fully-qualified images referring to container registries." }, { "info": { "name": "Tag an image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/images/:name/tag", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name or ID of the container" }, { "name": "repo", "value": "", "type": "query", "description": "the repository to tag in" }, { "name": "tag", "value": "", "type": "query", "description": "the name of the new tag" } ] }, "docs": "Tag an image so that it becomes part of a repository." }, { "info": { "name": "Image tree", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/libpod/images/:name/tree", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name or ID of the container" }, { "name": "whatrequires", "value": "", "type": "query", "description": "show all child images and layers of the specified image" } ] }, "docs": "Retrieve the image tree for the provided image name or ID" }, { "info": { "name": "Untag an image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/images/:name/untag", "params": [ { "name": "name", "value": "", "type": "path", "description": "the name or ID of the container" }, { "name": "repo", "value": "", "type": "query", "description": "the repository to untag" }, { "name": "tag", "value": "", "type": "query", "description": "the name of the tag to untag" } ] }, "docs": "Untag an image. If not repo and tag are specified, all tags are removed from the image." }, { "info": { "name": "Export multiple images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/libpod/images/export", "params": [ { "name": "format", "value": "", "type": "query", "description": "format for exported image (only docker-archive is supported)" }, { "name": "references", "value": "", "type": "query", "description": "references to images to export" }, { "name": "compress", "value": "", "type": "query", "description": "use compression on image" }, { "name": "ociAcceptUncompressedLayers", "value": "", "type": "query", "description": "accept uncompressed layers when copying OCI images" } ] }, "docs": "Export multiple images into a single object. Only `docker-archive` is currently supported." }, { "info": { "name": "Import image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/images/import", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "changes", "value": "", "type": "query", "description": "Apply the following possible instructions to the created image: CMD | ENTRYPOINT | ENV | EXPOSE | LABEL | STOPSIGNAL | USER | VOLUME | WORKDIR. JSON encoded string" }, { "name": "message", "value": "", "type": "query", "description": "Set commit message for imported image" }, { "name": "reference", "value": "", "type": "query", "description": "Optional Name[:TAG] for the image" }, { "name": "url", "value": "", "type": "query", "description": "Load image from the specified URL" } ] }, "docs": "Import a previously exported tarball as an image." }, { "info": { "name": "List Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/libpod/images/json", "params": [ { "name": "all", "value": "", "type": "query", "description": "Show all images. Only images from a final layer (no children) are shown by default." }, { "name": "filters", "value": "", "type": "query", "description": "JSON-encoded string containing filters as a `map[string][]string` to process on the images list. Available filters:\n- `before`=(`[:]`, `` or ``)\n- `dangling=true`\n- `label=key` or `label=\"key=value\"` of an image label\n- `reference`=(`[:]`)\n- `id`=(``)\n- `since`=(`[:]`, `` or ``)\n" } ] }, "docs": "Returns a list of images on the server" }, { "info": { "name": "Load image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/images/load" }, "docs": "Load an image (oci-archive or docker-archive) stream." }, { "info": { "name": "Prune unused images", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/images/prune", "params": [ { "name": "all", "value": "", "type": "query", "description": "Remove all images not in use by containers, not just dangling ones\n" }, { "name": "external", "value": "", "type": "query", "description": "Remove images even when they are used by external containers (e.g, by build containers)\n" }, { "name": "buildcache", "value": "", "type": "query", "description": "Remove persistent build cache created by build instructions such as `--mount=type=cache`.\n" }, { "name": "filters", "value": "", "type": "query", "description": "filters to apply to image pruning, encoded as JSON (map[string][]string). Available filters:\n - `dangling=` When set to `true` (or `1`), prune only\n unused *and* untagged images. When set to `false`\n (or `0`), all unused images are pruned.\n - `until=` Prune images created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels.\n" } ] }, "docs": "Remove images that are not being used by a container" }, { "info": { "name": "Pull images", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/images/pull", "headers": [ { "name": "X-Registry-Auth", "value": "" } ], "params": [ { "name": "reference", "value": "", "type": "query", "description": "Mandatory reference to the image (e.g., quay.io/image/name:tag)" }, { "name": "quiet", "value": "", "type": "query", "description": "Silence extra stream data on pull. Cannot be used with 'compatMode' or 'pullProgress'." }, { "name": "compatMode", "value": "", "type": "query", "description": "Return the same JSON payload as the Docker-compat endpoint. Cannot be used with 'pullProgress' or 'quiet'." }, { "name": "pullProgress", "value": "", "type": "query", "description": "Send reports about the progress of the pull. Cannot be used with 'compatMode' or 'quiet'." }, { "name": "Arch", "value": "", "type": "query", "description": "Pull image for the specified architecture." }, { "name": "OS", "value": "", "type": "query", "description": "Pull image for the specified operating system." }, { "name": "Variant", "value": "", "type": "query", "description": "Pull image for the specified variant." }, { "name": "policy", "value": "", "type": "query", "description": "Pull policy, \"always\" (default), \"missing\", \"newer\", \"never\"." }, { "name": "tlsVerify", "value": "", "type": "query", "description": "Require TLS verification." }, { "name": "allTags", "value": "", "type": "query", "description": "Pull all tagged images in the repository." } ] }, "docs": "Pull one or more images from a container registry. Error status codes can come either from the API or from the registry. Errors may be detected later even if the HTTP status 200 is returned, and in that case, the error description will be in the `error` field." }, { "info": { "name": "Remove one or more images from the storage.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/libpod/images/remove", "params": [ { "name": "images", "value": "", "type": "query", "description": "Images IDs or names to remove." }, { "name": "all", "value": "", "type": "query", "description": "Remove all images." }, { "name": "force", "value": "", "type": "query", "description": "Force image removal (including containers using the images)." }, { "name": "ignore", "value": "", "type": "query", "description": "Ignore if a specified image does not exist and do not throw an error." }, { "name": "lookupManifest", "value": "", "type": "query", "description": "Resolves to manifest list instead of image." } ] }, "docs": "Remove one or more images from the storage." }, { "info": { "name": "Copy an image from one host to another", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/images/scp/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "source connection/image" }, { "name": "destination", "value": "", "type": "query", "description": "dest connection/image" }, { "name": "quiet", "value": "", "type": "query", "description": "quiet output" } ] }, "docs": "Copy an image from one host to another" }, { "info": { "name": "Search images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/libpod/images/search", "params": [ { "name": "term", "value": "", "type": "query", "description": "term to search" }, { "name": "limit", "value": "", "type": "query", "description": "maximum number of results" }, { "name": "filters", "value": "", "type": "query", "description": "JSON-encoded string containing filters as a `map[string][]string` to process on the images list. Available filters:\n- `is-automated=(true|false)`\n- `is-official=(true|false)`\n- `stars=` Matches images that have at least 'number' stars.\n" }, { "name": "tlsVerify", "value": "", "type": "query", "description": "Require HTTPS and verify signatures when contacting registries." }, { "name": "listTags", "value": "", "type": "query", "description": "list the available tags in the repository" } ] }, "docs": "Search registries for images" }, { "info": { "name": "Create image from local build context", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/local/build", "headers": [ { "name": "X-Registry-Config", "value": "" } ], "params": [ { "name": "localcontextdir", "value": "", "type": "query", "description": "Absolute path to the build context directory on the server filesystem.\nThis directory must contain all files needed for the build.\n" }, { "name": "dockerfile", "value": "", "type": "query", "description": "Absolute path within the build context to the `Dockerfile`.\nThis is ignored if remote is specified and points to an external `Dockerfile`.\n" }, { "name": "t", "value": "", "type": "query", "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 parameters." }, { "name": "allplatforms", "value": "", "type": "query", "description": "Instead of building for a set of platforms specified using the platform option, inspect the build's base images,\nand build for all of the platforms that are available. Stages that use *scratch* as a starting point can not be inspected,\nso at least one non-*scratch* stage must be present for detection to work usefully.\n" }, { "name": "additionalbuildcontexts", "value": "", "type": "query", "description": "Additional build contexts for builds that require more than one context.\nEach additional context must be specified as a key-value pair in the format \"name=value\".\n\nThe value can be specified in three formats:\n- URL context: Use the prefix \"url:\" followed by a URL to a tar archive\n Example: \"mycontext=url:https://example.com/context.tar\"\n- Image context: Use the prefix \"image:\" followed by an image reference\n Example: \"mycontext=image:alpine:latest\" or \"mycontext=image:docker.io/library/ubuntu:22.04\"\n- Local path context: Use the prefix \"localpath:\" followed by an absolute path on the server filesystem\n Example: \"mycontext=localpath:/path/to/context/dir\"\n\n(As of version 5.6.0)\n" }, { "name": "extrahosts", "value": "", "type": "query", "description": "TBD Extra hosts to add to /etc/hosts\n(As of version 1.xx)\n" }, { "name": "nohosts", "value": "", "type": "query", "description": "Not to create /etc/hosts when building the image\n" }, { "name": "remote", "value": "", "type": "query", "description": "A Git repository URI or HTTP/HTTPS context URI.\nIf the URI points to a single text file, the file's contents are placed\ninto a file called Dockerfile and the image is built from that file. If\nthe URI points to a tarball, the file is downloaded by the daemon and the\ncontents therein used as the context for the build. If the URI points to a\ntarball and the dockerfile parameter is also specified, there must be a file\nwith the corresponding path inside the tarball.\n(As of version 1.xx)\n" }, { "name": "q", "value": "", "type": "query", "description": "Suppress verbose build output\n" }, { "name": "compatvolumes", "value": "", "type": "query", "description": "Contents of volume locations to be modified on ADD or COPY only\n(As of Podman version v5.2)\n" }, { "name": "createdannotation", "value": "", "type": "query", "description": "Add an \"org.opencontainers.image.created\" annotation to the\nimage.\n(As of Podman version v5.6)\n" }, { "name": "sourcedateepoch", "value": "", "type": "query", "description": "Timestamp to use for newly-added history entries and the image's\ncreation date.\n(As of Podman version v5.6)\n" }, { "name": "rewritetimestamp", "value": "", "type": "query", "description": "If sourcedateepoch is set, force new content added in layers to\nhave timestamps no later than the sourcedateepoch date.\n(As of Podman version v5.6)\n" }, { "name": "timestamp", "value": "", "type": "query", "description": "Timestamp to use for newly-added history entries, the image's\ncreation date, and for new content added in layers.\n" }, { "name": "inheritlabels", "value": "", "type": "query", "description": "Inherit the labels from the base image or base stages\n(As of Podman version v5.5)\n" }, { "name": "inheritannotations", "value": "", "type": "query", "description": "Inherit the annotations from the base image or base stages\n(As of Podman version v5.6)\n" }, { "name": "nocache", "value": "", "type": "query", "description": "Do not use the cache when building the image\n(As of version 1.xx)\n" }, { "name": "cachefrom", "value": "", "type": "query", "description": "JSON array of images used to build cache resolution\n(As of version 1.xx)\n" }, { "name": "pull", "value": "", "type": "query", "description": "Attempt to pull the image even if an older image exists locally\n(As of version 1.xx)\n" }, { "name": "rm", "value": "", "type": "query", "description": "Remove intermediate containers after a successful build\n(As of version 1.xx)\n" }, { "name": "forcerm", "value": "", "type": "query", "description": "Always remove intermediate containers, even upon failure\n(As of version 1.xx)\n" }, { "name": "memory", "value": "", "type": "query", "description": "Memory is the upper limit (in bytes) on how much memory running containers can use\n(As of version 1.xx)\n" }, { "name": "memswap", "value": "", "type": "query", "description": "MemorySwap limits the amount of memory and swap together\n(As of version 1.xx)\n" }, { "name": "cpushares", "value": "", "type": "query", "description": "CPUShares (relative weight\n(As of version 1.xx)\n" }, { "name": "cpusetcpus", "value": "", "type": "query", "description": "CPUSetCPUs in which to allow execution (0-3, 0,1)\n(As of version 1.xx)\n" }, { "name": "cpuperiod", "value": "", "type": "query", "description": "CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period\n(As of version 1.xx)\n" }, { "name": "cpuquota", "value": "", "type": "query", "description": "CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota\n(As of version 1.xx)\n" }, { "name": "buildargs", "value": "", "type": "query", "description": "JSON map of string pairs denoting build-time variables.\nFor example, the build argument `Foo` with the value of `bar` would be encoded in JSON as `[\"Foo\":\"bar\"]`.\n\nFor example, buildargs={\"Foo\":\"bar\"}.\n\nNote(s):\n* This should not be used to pass secrets.\n* The value of buildargs should be URI component encoded before being passed to the API.\n\n(As of version 1.xx)\n" }, { "name": "shmsize", "value": "", "type": "query", "description": "ShmSize is the \"size\" value to use when mounting an shmfs on the container's /dev/shm directory.\nDefault is 64MB\n(As of version 1.xx)\n" }, { "name": "squash", "value": "", "type": "query", "description": "Silently ignored.\nSquash the resulting images layers into a single layer\n(As of version 1.xx)\n" }, { "name": "labels", "value": "", "type": "query", "description": "JSON map of key, value pairs to set as labels on the new image\n(As of version 1.xx)\n" }, { "name": "layerLabel", "value": "", "type": "query", "description": "Add an intermediate image *label* (e.g. label=*value*) to the intermediate image metadata." }, { "name": "layers", "value": "", "type": "query", "description": "Cache intermediate layers during build.\n(As of version 1.xx)\n" }, { "name": "networkmode", "value": "", "type": "query", "description": "Sets the networking mode for the run commands during build.\nSupported standard values are:\n * `bridge` limited to containers within a single host, port mapping required for external access\n * `host` no isolation between host and containers on this network\n * `none` disable all networking for this container\n * container: share networking with given container\n ---All other values are assumed to be a custom network's name\n(As of version 1.xx)\n" }, { "name": "platform", "value": "", "type": "query", "description": "Platform format os[/arch[/variant]]\n(As of version 1.xx)\n" }, { "name": "target", "value": "", "type": "query", "description": "Target build stage\n(As of version 1.xx)\n" }, { "name": "outputs", "value": "", "type": "query", "description": "output configuration TBD\n(As of version 1.xx)\n" }, { "name": "httpproxy", "value": "", "type": "query", "description": "Inject http proxy environment variables into container\n(As of version 2.0.0)\n" }, { "name": "unsetenv", "value": "", "type": "query", "description": "Unset environment variables from the final image." }, { "name": "unsetlabel", "value": "", "type": "query", "description": "Unset the image label, causing the label not to be inherited from the base image." }, { "name": "unsetannotation", "value": "", "type": "query", "description": "Unset the image annotation, causing the annotation not to be inherited from the base image.\n(As of Podman version v5.6)\n" }, { "name": "volume", "value": "", "type": "query", "description": "Extra volumes that should be mounted in the build container." }, { "name": "manifest", "value": "", "type": "query", "description": "Add the image to the specified manifest list. Creates a manifest list if it does not exist.\n" } ] }, "docs": "Build an image from a local build context directory without requiring tar archive upload. The build context must already exist on the server filesystem." }, { "info": { "name": "Load image from local path", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/libpod/local/images/load", "params": [ { "name": "path", "value": "", "type": "query", "description": "Absolute path to the image archive file on the server filesystem" } ] }, "docs": "Load an image (oci-archive or docker-archive) from a file path accessible on the server." } ] } ], "bundled": true }