List and query images.

Documents & examples

Method: GET

URL: /rest_api/v1/images/

Query params:

  • arch (string)
  • bootable (bool)
  • compose (string)
  • disc_count (int)
  • disc_number (int)
  • file_name (string)
  • image_format (string)
  • image_type (string)
  • implant_md5 (string)
  • md5 (string)
  • mtime (int)
  • sha1 (string)
  • sha256 (string)
  • size (int)
  • subvariant (string)
  • volume_id (string)
  • ordering (string) Comma separated list of fields for ordering results.
    • To sort by a field in descending order, prefix its name with minus (e.g. -name).
    • Use double underscores for nested field names (e.g. parent__child for {"parent": {"child": ...}}).

Following filters can be used to show only specific fields. This can make response time faster. Format is list or single value (JSON: {"fields": ["a","b"]} or {"fields": "a"}, in URL: ?fields=a&fields=b).

  • fields (list | string) Fields to display (other fields will be hidden).
  • exclude_fields: (list | string) Fields NOT to display (overrules fields).

The compose filter allows filtering images connected to a particular compose. The value should be compose ID.

If the same filter is specified multiple times, it will do a OR query.

Response: a paged list of following objects

{
    "arch": "string", 
    "bootable (optional, default=false)": "boolean", 
    "composes (read-only)": [
        "compose_id"
    ], 
    "disc_count": "int", 
    "disc_number": "int", 
    "file_name": "string", 
    "image_format": "ImageFormat.name", 
    "image_type": "ImageType.name", 
    "implant_md5 (optional, default=null, nullable)": "string", 
    "md5 (optional, default=null, nullable)": "string", 
    "mtime": "int", 
    "sha1 (optional, default=null, nullable)": "string", 
    "sha256": "string", 
    "size": "int", 
    "subvariant (optional, default=\"\")": "string", 
    "volume_id (optional, default=null, nullable)": "string"
}

Browsable GET

GET /rest_api/v1/images/?page=12894
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 265773,
    "next": "https://pdc.fedoraproject.org/rest_api/v1/images/?page=12895",
    "previous": "https://pdc.fedoraproject.org/rest_api/v1/images/?page=12893",
    "results": [
        {
            "file_name": "Fedora-Container-Toolbox-39-20231205.0.aarch64.tar.xz",
            "image_format": "tar.xz",
            "image_type": "docker",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701762752,
            "size": 172060004,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "e43d496145fad068c4ae73832b1ae4b4d98bb8ba8d3ee83d6b2590b187c5f8f2",
            "composes": [
                "Fedora-Container-39-20231205.0"
            ],
            "subvariant": "Container_Toolbox"
        },
        {
            "file_name": "Fedora-Container-Toolbox-39-20231205.0.x86_64.tar.xz",
            "image_format": "tar.xz",
            "image_type": "docker",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701762828,
            "size": 195773252,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "da8f88c4954cfa7e310a47adb93ece31e48495b0aaa53f1cbe1ad054ef61686e",
            "composes": [
                "Fedora-Container-39-20231205.0"
            ],
            "subvariant": "Container_Toolbox"
        },
        {
            "file_name": "Fedora-Container-Base-39-20231205.0.x86_64.tar.xz",
            "image_format": "tar.xz",
            "image_type": "docker",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701762617,
            "size": 42726208,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "5ce0a8a92285db7611616d2dcf093315a182a674249b36082adc3908cbfd9775",
            "composes": [
                "Fedora-Container-39-20231205.0"
            ],
            "subvariant": "Container_Base"
        },
        {
            "file_name": "Fedora-Container-Minimal-Base-39-20231205.0.x86_64.tar.xz",
            "image_format": "tar.xz",
            "image_type": "docker",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701762597,
            "size": 26239220,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "784be8083520c69a661128ec9973b71e9975b6e50491a5930f5cf3d1452b2794",
            "composes": [
                "Fedora-Container-39-20231205.0"
            ],
            "subvariant": "Container_Minimal_Base"
        },
        {
            "file_name": "Fedora-Container-Base-39-20231205.0.s390x.tar.xz",
            "image_format": "tar.xz",
            "image_type": "docker",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "s390x",
            "mtime": 1701762551,
            "size": 41841880,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "7137c02e4cf82d461fabfc8637f61a7febd87b379c739d671be4d0edc1879b5a",
            "composes": [
                "Fedora-Container-39-20231205.0"
            ],
            "subvariant": "Container_Base"
        },
        {
            "file_name": "Fedora-Container-Minimal-Base-39-20231205.0.s390x.tar.xz",
            "image_format": "tar.xz",
            "image_type": "docker",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "s390x",
            "mtime": 1701762535,
            "size": 25190284,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "70ffb59ae4744d137519231780ff59398d82555c360810c537444064cf099b2d",
            "composes": [
                "Fedora-Container-39-20231205.0"
            ],
            "subvariant": "Container_Minimal_Base"
        },
        {
            "file_name": "Fedora-Container-Toolbox-39-20231205.0.s390x.tar.xz",
            "image_format": "tar.xz",
            "image_type": "docker",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "s390x",
            "mtime": 1701762691,
            "size": 161511292,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "84298ba9ed8416d6ab0837e036b6337f3fd797e55355ff81f7d9e26b4ae7f465",
            "composes": [
                "Fedora-Container-39-20231205.0"
            ],
            "subvariant": "Container_Toolbox"
        },
        {
            "file_name": "Fedora-Container-Toolbox-39-20231205.0.ppc64le.tar.xz",
            "image_format": "tar.xz",
            "image_type": "docker",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "ppc64le",
            "mtime": 1701765954,
            "size": 177390092,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "f091a22d7c4c91d5f2c10dbb1ca5271f6b8acfcff714059314971f086d1b28d2",
            "composes": [
                "Fedora-Container-39-20231205.0"
            ],
            "subvariant": "Container_Toolbox"
        },
        {
            "file_name": "Fedora-Container-Base-39-20231205.0.ppc64le.tar.xz",
            "image_format": "tar.xz",
            "image_type": "docker",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "ppc64le",
            "mtime": 1701765035,
            "size": 45416812,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "7e5af155c316a3588362ce78eacc02629920ad407981e6bf484387c2c83f2b21",
            "composes": [
                "Fedora-Container-39-20231205.0"
            ],
            "subvariant": "Container_Base"
        },
        {
            "file_name": "Fedora-Container-Minimal-Base-39-20231205.0.ppc64le.tar.xz",
            "image_format": "tar.xz",
            "image_type": "docker",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "ppc64le",
            "mtime": 1701764787,
            "size": 27960184,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "e69d6db6d8c6aa7daf13541e58ff1e24a17f7fc73de428ce9b12ee841caec1b9",
            "composes": [
                "Fedora-Container-39-20231205.0"
            ],
            "subvariant": "Container_Minimal_Base"
        },
        {
            "file_name": "Fedora-Cloud-Base-Rawhide-20231205.n.1.aarch64.raw.xz",
            "image_format": "raw.xz",
            "image_type": "raw-xz",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701800953,
            "size": 493902900,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "8e395a886e7eecc9d28396d787d8859aa1d80e4738ca41d91eb2f57745146ab7",
            "composes": [
                "Fedora-Rawhide-20231205.n.1"
            ],
            "subvariant": "Cloud_Base"
        },
        {
            "file_name": "Fedora-Cloud-Base-Azure-Rawhide-20231205.n.1.aarch64.vhd",
            "image_format": "vhd",
            "image_type": "vpc",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701800811,
            "size": 1290076160,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "6f1dc30dab35cfdbe772eeb20ae07bce727eaa30df8583b6df4566d509b6ae41",
            "composes": [
                "Fedora-Rawhide-20231205.n.1"
            ],
            "subvariant": "Cloud_Base"
        },
        {
            "file_name": "Fedora-Cloud-Base-Rawhide-20231205.n.1.aarch64.qcow2",
            "image_format": "qcow2",
            "image_type": "qcow2",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701800940,
            "size": 610140160,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "6c305ff5ac41d8dcb9b1ad014e3790518852e2ae92bc8487b06f845570c8138e",
            "composes": [
                "Fedora-Rawhide-20231205.n.1"
            ],
            "subvariant": "Cloud_Base"
        },
        {
            "file_name": "Fedora-Cloud-Base-Azure-Rawhide-20231205.n.1.x86_64.vhd",
            "image_format": "vhd",
            "image_type": "vpc",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701800472,
            "size": 1220853248,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "fa515b64965613c9b65d92e1214d35e2573366f1bc3ad2ea7d4ca464b1ef987a",
            "composes": [
                "Fedora-Rawhide-20231205.n.1"
            ],
            "subvariant": "Cloud_Base"
        },
        {
            "file_name": "Fedora-Cloud-Base-Rawhide-20231205.n.1.x86_64.raw.xz",
            "image_format": "raw.xz",
            "image_type": "raw-xz",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701800258,
            "size": 488106152,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "c52e0401573e194a2d85c89c153cfe4379101d4a187a20a9d0bb00949bdd6919",
            "composes": [
                "Fedora-Rawhide-20231205.n.1"
            ],
            "subvariant": "Cloud_Base"
        },
        {
            "file_name": "Fedora-Cloud-Base-GCP-Rawhide-20231205.n.1.x86_64.tar.gz",
            "image_format": "tar.gz",
            "image_type": "tar-gz",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701800302,
            "size": 608641096,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "e02a6b382ceb125d452e7476fe70b300d2301037ec900e93abe9dea7ee19003c",
            "composes": [
                "Fedora-Rawhide-20231205.n.1"
            ],
            "subvariant": "Cloud_Base"
        },
        {
            "file_name": "Fedora-Cloud-Base-Rawhide-20231205.n.1.x86_64.qcow2",
            "image_format": "qcow2",
            "image_type": "qcow2",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701800177,
            "size": 593952768,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "cf3ede1fbaa2b6b20724917607031261c09e23b48a98ce09dc5e41e0ecb2cc0b",
            "composes": [
                "Fedora-Rawhide-20231205.n.1"
            ],
            "subvariant": "Cloud_Base"
        },
        {
            "file_name": "Fedora-Cloud-Base-Vagrant-Rawhide-20231205.n.1.x86_64.vagrant-virtualbox.box",
            "image_format": "vagrant-virtualbox.box",
            "image_type": "vagrant-virtualbox",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701800930,
            "size": 597483520,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "6abc462350324e15f8c41024c6ba77875b1bc15409a2fcffbc03e98cf5367589",
            "composes": [
                "Fedora-Rawhide-20231205.n.1"
            ],
            "subvariant": "Cloud_Base"
        },
        {
            "file_name": "Fedora-Cloud-Base-Vagrant-Rawhide-20231205.n.1.x86_64.vagrant-libvirt.box",
            "image_format": "vagrant-libvirt.box",
            "image_type": "vagrant-libvirt",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701800918,
            "size": 585071464,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "cfd070c217dc0e4b54938c7c9a426b143f810482cdfee00e40c0dba08a6978cc",
            "composes": [
                "Fedora-Rawhide-20231205.n.1"
            ],
            "subvariant": "Cloud_Base"
        },
        {
            "file_name": "Fedora-Cloud-Base-Rawhide-20231205.n.1.s390x.qcow2",
            "image_format": "qcow2",
            "image_type": "qcow2",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "s390x",
            "mtime": 1701800271,
            "size": 573702144,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "94b85b834c668c9fe5e48a9ece2912984760cb2eb750c2fd7da7d3b7be3ba403",
            "composes": [
                "Fedora-Rawhide-20231205.n.1"
            ],
            "subvariant": "Cloud_Base"
        }
    ]
}