JSON payload for API

[Pilzington]

Hello,

I am currently trying out the podman API. At the moment I am trying to delete all unused images. For that I call /libpod/images/prune. The documentation states I need to set dangling=false. But I can not work out how to do the correct structure which is accepted. Since it is a POST I am guessing I need to send a JSON payload or is it with url parameters?

Here is the code I tried. How do you do this correctly?

        request_url = self.URL + 'images/prune'
        json = {
            'filters': [{
                'dangling': 'false'
            }]
        }
        request = requests.post(request_url, json=json)

Thanks for any help!

[mheon]

@baude PTAL

[baude]

the docs state that filters are a map[string][]string. i.e. a dict with string key that points to a string list. does that help

[Pilzington]

@baude Thanks for your response!
I tried it with this JSON:

{
    "filters": [
        {
            "dangling": false
        }
    ]
}

This is sadly not working.
Does the API even take a JSON payload? Since the documentation is mentioning '=' it maybe has to be in the URL.
Can you please point me to the API definition in the source code? I can not find it myself. I think it will become clear when I see the actual code.

[Pilzington]

@baude So I found the API source code. You need to put the JSON in the URL. I got to the point where no errors are thrown anymore by the API service in debug mode. Still it is not work as intended. I guess the JSON is not in the right in the format.
Here is the current link I am trying. I guess the key for the array is wrong, but I have no idea what it could be instead.
images/prune?filters={"filters":["dangling=false"]}'

Maybe someone has an idea.

[Luap99]

The json structure is a map[string][]string, so it should be {"dangling":["false"]} in your case. I think you also have to url encode this string.

[Pilzington]

@Luap99 Thanks for the hint. I tried this structure but it has not the expected effect. Maybe I do not unterstand it correctly.
From the reference:
dangling= When set to true (or 1), prune only unused and untagged images. When set to false (or 0), all unused images are pruned.

The containers I am running:

$ podman ps -a
CONTAINER ID  IMAGE                           COMMAND               CREATED       STATUS                   PORTS   NAMES
96f979df67f8  docker.io/library/nginx:latest  nginx -g daemon o...  8 months ago  Created                          eager_galileo
3feab14398e0  docker.io/library/nginx:latest  nginx -g daemon o...  8 months ago  Exited (0) 8 months ago          cranky_easley

My images:

$ podman images
REPOSITORY                TAG     IMAGE ID      CREATED        SIZE
localhost/dangling-test   1.0     fb4a1e39208a  17 hours ago   159 MB
docker.io/library/python  latest  49e3c70d884f  2 weeks ago    909 MB
docker.io/library/nginx   latest  4bb46517cac3  8 months ago   137 MB
docker.io/library/alpine  3.8     c8bccc0af957  15 months ago  4.67 MB

I would expect all of them gone, except docker.io/library/nginx, but this dose not happen. Only dangling Images are deleted.
Podman output:

DEBU[0233] APIHandler -- Method: POST URL: /v3.0.0/libpod/images/prune?filters=%7B%22dangling%22:%5B%22false%22%5D%7D 
DEBU[0233] parsed reference into "[vfs@/home/alex/.local/share/containers/storage+/run/user/1001/containers]@4bb46517cac397bdb0bab6eba09b0e1f8e90ddd17cf99662997c3253531136f8" 
DEBU[0233] exporting opaque data as blob "sha256:4bb46517cac397bdb0bab6eba09b0e1f8e90ddd17cf99662997c3253531136f8" 
DEBU[0233] parsed reference into "[vfs@/home/alex/.local/share/containers/storage+/run/user/1001/containers]@c8bccc0af9571ec0d006a43acb5a8d08c4ce42b6cc7194dd6eb167976f501ef1" 
DEBU[0233] exporting opaque data as blob "sha256:c8bccc0af9571ec0d006a43acb5a8d08c4ce42b6cc7194dd6eb167976f501ef1" 
DEBU[0233] parsed reference into "[vfs@/home/alex/.local/share/containers/storage+/run/user/1001/containers]@5013c337f0ac774e33c1d2280cbca0f4cfb9c9df856db864a7a252e1788b3495" 
DEBU[0233] exporting opaque data as blob "sha256:5013c337f0ac774e33c1d2280cbca0f4cfb9c9df856db864a7a252e1788b3495" 
DEBU[0233] parsed reference into "[vfs@/home/alex/.local/share/containers/storage+/run/user/1001/containers]@544201206891fe967d1f3e51628e3e76233897938fa9c3b3a0786526981000b0" 
DEBU[0233] exporting opaque data as blob "sha256:544201206891fe967d1f3e51628e3e76233897938fa9c3b3a0786526981000b0" 
DEBU[0233] parsed reference into "[vfs@/home/alex/.local/share/containers/storage+/run/user/1001/containers]@49e3c70d884f2640959e0392c03f5352d852e673a28dca3b16d2d9c400149906" 
DEBU[0233] exporting opaque data as blob "sha256:49e3c70d884f2640959e0392c03f5352d852e673a28dca3b16d2d9c400149906" 
DEBU[0233] parsed reference into "[vfs@/home/alex/.local/share/containers/storage+/run/user/1001/containers]@1ed08bc88a655e6a3bab9b9519a4ebec0cbef53c0ec3c2a615a627bcd18f29d6" 
DEBU[0233] exporting opaque data as blob "sha256:1ed08bc88a655e6a3bab9b9519a4ebec0cbef53c0ec3c2a615a627bcd18f29d6" 
DEBU[0233] parsed reference into "[vfs@/home/alex/.local/share/containers/storage+/run/user/1001/containers]@ae84b09f299abebc2cfab4076d33cfa43cf2caae5df8c1dd631033f06d363c60" 
DEBU[0233] exporting opaque data as blob "sha256:ae84b09f299abebc2cfab4076d33cfa43cf2caae5df8c1dd631033f06d363c60" 
DEBU[0233] parsed reference into "[vfs@/home/alex/.local/share/containers/storage+/run/user/1001/containers]@b69ef4a0c9be00b8715e643ab98e845fa1b16efac7db22ac3f419d4f929db7e2" 
DEBU[0233] exporting opaque data as blob "sha256:b69ef4a0c9be00b8715e643ab98e845fa1b16efac7db22ac3f419d4f929db7e2" 
DEBU[0233] parsed reference into "[vfs@/home/alex/.local/share/containers/storage+/run/user/1001/containers]@89567b4416b589168540d25e96eed858946536674cdf3805216266fe486fd4f8" 
DEBU[0233] exporting opaque data as blob "sha256:89567b4416b589168540d25e96eed858946536674cdf3805216266fe486fd4f8" 
DEBU[0233] parsed reference into "[vfs@/home/alex/.local/share/containers/storage+/run/user/1001/containers]@fb4a1e39208ad6dd9a4d41c46eec23f9352f4bb1f4929cd83a0fe7febdef60af" 
DEBU[0233] exporting opaque data as blob "sha256:fb4a1e39208ad6dd9a4d41c46eec23f9352f4bb1f4929cd83a0fe7febdef60af" 
DEBU[0233] IdleTracker 0xc000010070:idle 1/12 connection(s) 
DEBU[0233] IdleTracker 0xc000010070:closed 0/12 connection(s) 
DEBU[0233] IdleTracker 0xc00051c8d8:new 0/12 connection(s) 
DEBU[0233] IdleTracker 0xc00051c8d8:active 1/13 connection(s)