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=2
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 265849,
    "next": "https://pdc.fedoraproject.org/rest_api/v1/images/?page=3",
    "previous": "https://pdc.fedoraproject.org/rest_api/v1/images/",
    "results": [
        {
            "file_name": "Fedora-Workstation-boot-x86_64-24-20160203.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454476919,
            "size": 464519168,
            "bootable": true,
            "implant_md5": "ca144156e6f9b50077161590e0702ba8",
            "volume_id": "Fedora-WS-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "e9f79238a0bf024fe2a781aae39e90fcf7b442b3bd4d56c242af7dcaeec39494",
            "composes": [
                "Fedora-24-20160203.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Workstation-boot-i386-24-20160203.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454475952,
            "size": 521142272,
            "bootable": true,
            "implant_md5": "db74420ab00fa0fcf8af8ba54b52e5cf",
            "volume_id": "Fedora-WS-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "d92982f77f009b5bc2f687ce2b8b9b8b12daebccbd971cf83f13542a41fbe309",
            "composes": [
                "Fedora-24-20160203.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Cloud-boot-x86_64-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454523720,
            "size": 467664896,
            "bootable": true,
            "implant_md5": "1d84a3cb2a97f9718591b4164c20f44b",
            "volume_id": "Fedora-C-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "fd8fe19c3b232d0a0ee3fe18f20b025223d4bea3f02a5b0600d34778af04dd9b",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Cloud-boot-i386-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454523911,
            "size": 526385152,
            "bootable": true,
            "implant_md5": "fc0b8c86a2f202ef2f3b58e5e4bcfe4c",
            "volume_id": "Fedora-C-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "e9c4c4d43f044f050fa770e75cc23b29e939f2ada75b5a24970df870fb9afa91",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Everything-boot-x86_64-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454523430,
            "size": 467664896,
            "bootable": true,
            "implant_md5": "2231ba8ba0b595f3f7283ddc5026550f",
            "volume_id": "Fedora-Everything-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "6692a503ad6d6da62d65b3b40c0a0eb44c82ac57ddf2c021d537a2b0f4435ace",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Everything-boot-i386-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454525122,
            "size": 526385152,
            "bootable": true,
            "implant_md5": "defbae4fd159a05067c35adef2b64774",
            "volume_id": "Fedora-Everything-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "43addf7b1ed4837c280508072facb9419ebea2e239a10562b530e46641c94f36",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-boot-x86_64-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454524362,
            "size": 469762048,
            "bootable": true,
            "implant_md5": "c4ffa30f9acd926f18cfb292dd053a31",
            "volume_id": "Fedora-S-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "1b05be81cbf698a53d438d103f642b5f2565b580183e9365f3d2f382b85ebba3",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-dvd-x86_64-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "dvd",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454526986,
            "size": 1853882368,
            "bootable": true,
            "implant_md5": "566d1b5a8ff65752266592b7454061bf",
            "volume_id": "Fedora-S-dvd-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "78e3d6e18f2d1d45c988e1026581d7c3f5b7b5f772423c09e0b9af7578bf43b5",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-boot-i386-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454523912,
            "size": 528482304,
            "bootable": true,
            "implant_md5": "8709b2dd9d72bcad9f31dc155f5936a3",
            "volume_id": "Fedora-S-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "0d8a91829b187201496c69e13a14ab468e083258ae3f9436696a469c7e522320",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-dvd-i386-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "dvd",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454526987,
            "size": 1948254208,
            "bootable": true,
            "implant_md5": "cd459fe91f1fc3faa70f408b108413b6",
            "volume_id": "Fedora-S-dvd-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "f5cbf5195dd14e29c58ea338115d199bba425c0e852a7790b7ea84de9de654ee",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-dvd-armhfp-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "dvd",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "armhfp",
            "mtime": 1454527114,
            "size": 1765007360,
            "bootable": true,
            "implant_md5": "953de84959f2c313bbeff113aec7e6d0",
            "volume_id": "Fedora-S-dvd-armhfp-24",
            "md5": null,
            "sha1": null,
            "sha256": "36297f9f9016626b10ec348f85fa8a4f10f095c2b09bd3577d113032c5183ef6",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Workstation-boot-x86_64-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454525352,
            "size": 467664896,
            "bootable": true,
            "implant_md5": "06351bf847a7b815bccf355ede925460",
            "volume_id": "Fedora-WS-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "8c7c2622d6a79ccbdddad66302e77559b20ae85405bfd242f38e92e5e96c3632",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Workstation-boot-i386-24-20160203.n.1.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454525130,
            "size": 527433728,
            "bootable": true,
            "implant_md5": "efea71523393285b6c53f376838d58e9",
            "volume_id": "Fedora-WS-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "38fb571226b50c4ef0d87af0b17ef705b358d1d009870c330ff72ef6502bb2c2",
            "composes": [
                "Fedora-24-20160203.n.1"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Cloud-boot-x86_64-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454588860,
            "size": 467664896,
            "bootable": true,
            "implant_md5": "d93c9ee7a89fda901eb945e8fa5b29b6",
            "volume_id": "Fedora-C-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "610710a947e01e6c44f4e6b9621b22f43db78d34f0272d23908456f2ff44d328",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Cloud-boot-i386-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454589105,
            "size": 526385152,
            "bootable": true,
            "implant_md5": "15893f92a074cebd53e7a08345940c8f",
            "volume_id": "Fedora-C-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "ce58a6a9d2c6c252ef26b78cddbc16ad46ad545a2b59fcc10b4becb49257ce07",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Everything-boot-x86_64-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454589425,
            "size": 467664896,
            "bootable": true,
            "implant_md5": "d7f330831921da1031636af69d3386f4",
            "volume_id": "Fedora-Everything-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "118094f3d1d0a5fc2b78beceb83a81eb9560a67ade3862d1a251384707911c96",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Everything-boot-i386-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454589614,
            "size": 526385152,
            "bootable": true,
            "implant_md5": "854b57f5aa04666abb5baba20ca54fc5",
            "volume_id": "Fedora-Everything-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "3a93a0f84e495983802672aede85ed33ca14d0a89210b3c24ddf29da2f9cf9d0",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-dvd-x86_64-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "dvd",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454593039,
            "size": 1853882368,
            "bootable": true,
            "implant_md5": "f47f026a64b0338a4e707160f04e0e56",
            "volume_id": "Fedora-S-dvd-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "4a9e5faa9d7d242a91892787813c57a2b1ffb5f5479246d6a9215bc8c0022847",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-boot-x86_64-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454589859,
            "size": 469762048,
            "bootable": true,
            "implant_md5": "c81619d420b140e756c2f8e1483d30b2",
            "volume_id": "Fedora-S-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "68b4d3534b04f976031acbc6b243b50d3a15b01cb4163b6a4b9cf9531088bdeb",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-dvd-i386-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "dvd",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454592971,
            "size": 1949302784,
            "bootable": true,
            "implant_md5": "23dcaefbb3494c2fe76e0d33ee96aa27",
            "volume_id": "Fedora-S-dvd-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "5e1d59d6990a6ea5fe61db63c8979540a01dcb11c8cf3ce6571101a8d631a210",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        }
    ]
}