summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorSascha Grunert <sgrunert@suse.com>2019-12-16 13:28:16 +0100
committerSascha Grunert <sgrunert@suse.com>2020-01-08 10:06:10 +0100
commit40b74e02b77e83c377fdae83f626f83403b38152 (patch)
treec71e9d5c4cd1c1517006368c151b81c4ea5d4077 /API.md
parentc41fd09a8da3a96bc0e58f9f29f87b9bdf30264d (diff)
downloadpodman-40b74e02b77e83c377fdae83f626f83403b38152.tar.gz
podman-40b74e02b77e83c377fdae83f626f83403b38152.tar.bz2
podman-40b74e02b77e83c377fdae83f626f83403b38152.zip
Add `untag` sub-command
Podman now supports untagging images via the `untag` sub-command for the root and `image` commands. Testing and documentation has been added as well. Signed-off-by: Sascha Grunert <sgrunert@suse.com>
Diffstat (limited to 'API.md')
-rwxr-xr-xAPI.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/API.md b/API.md
index 469dbaa1b..05b08dc6f 100755
--- a/API.md
+++ b/API.md
@@ -185,6 +185,8 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in
[func UnpausePod(name: string) string](#UnpausePod)
+[func UntagImage(name: string, tag: string) string](#UntagImage)
+
[func VolumeCreate(options: VolumeCreateOpts) string](#VolumeCreate)
[func VolumeRemove(options: VolumeRemoveOpts) []string, map[string]](#VolumeRemove)
@@ -1234,6 +1236,14 @@ $ varlink call -m unix:/run/podman/io.podman/io.podman.UnpausePod '{"name": "foo
"pod": "1840835294cf076a822e4e12ba4152411f131bd869e7f6a4e8b16df9b0ea5c7f"
}
~~~
+### <a name="UntagImage"></a>func UntagImage
+<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;">
+
+method UntagImage(name: [string](https://godoc.org/builtin#string), tag: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div>
+UntagImage takes the name or ID of an image in local storage as well as the
+tag name to be removed. If the image cannot be found, an
+[ImageNotFound](#ImageNotFound) error will be returned; otherwise, the ID of
+the image is returned on success.
### <a name="VolumeCreate"></a>func VolumeCreate
<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;">