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=3
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=4",
    "previous": "https://pdc.fedoraproject.org/rest_api/v1/images/?page=2",
    "results": [
        {
            "file_name": "Fedora-Server-boot-i386-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454589646,
            "size": 529530880,
            "bootable": true,
            "implant_md5": "5ab299483b1581253f61ac630aa05788",
            "volume_id": "Fedora-S-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "65584c4fcb9af4753a0d50339568f0cef65c3976a3a37bcfe595c9ae71053c19",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-dvd-armhfp-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "dvd",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "armhfp",
            "mtime": 1454593129,
            "size": 1764982784,
            "bootable": true,
            "implant_md5": "ba47d493ead5c5d942b2e58c41c3eea9",
            "volume_id": "Fedora-S-dvd-armhfp-24",
            "md5": null,
            "sha1": null,
            "sha256": "a323b729d78376f64d6a52ef3143c9e1b3fe9ee24619f8f73f5b9511eb61837e",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Workstation-boot-x86_64-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454590093,
            "size": 467664896,
            "bootable": true,
            "implant_md5": "1c6f41e536287b24c4b3e58f1d368d6e",
            "volume_id": "Fedora-WS-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "c569a0892848f305d8288dc4945607055c57b1cb234a85534819afbf85d4827e",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Workstation-boot-i386-24-20160204.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454589195,
            "size": 526385152,
            "bootable": true,
            "implant_md5": "a930be2af194e3b9620a5b1a62b8b099",
            "volume_id": "Fedora-WS-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "da2b5123353785523c61293a3188fc4e5ac00e6c3160d8e302999c32b92f84d6",
            "composes": [
                "Fedora-24-20160204.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Cloud-boot-x86_64-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454837993,
            "size": 468713472,
            "bootable": true,
            "implant_md5": "7e38f2be072dd32184a8e6b6fdb009c2",
            "volume_id": "Fedora-C-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "043a1636bbe698b704fdcaa09ca829f95d02c4e4aee3c8b6b6605743732d9402",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Cloud-boot-i386-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454838595,
            "size": 528482304,
            "bootable": true,
            "implant_md5": "7a122453e3d85b14d5b376df012e90f1",
            "volume_id": "Fedora-C-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "04efaf6d4933c683a131c593e5bac9be0bbd51662b2f1c9c8c333bb02577ee21",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Everything-boot-x86_64-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454837894,
            "size": 468713472,
            "bootable": true,
            "implant_md5": "f40188b5d30f331a8f1357087b221ce8",
            "volume_id": "Fedora-Everything-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "180d130d592e930bbde9a463188e2d00da7b2b85a29ff76d1f29576be3e52126",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Everything-boot-i386-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454838369,
            "size": 528482304,
            "bootable": true,
            "implant_md5": "440071c214732555dfb83a49a99e77c0",
            "volume_id": "Fedora-Everything-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "85c0d102f5de674f35e125e82897510ab608d296e1cf0a575f1e8f2f86466311",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-dvd-x86_64-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "dvd",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454842014,
            "size": 1855979520,
            "bootable": true,
            "implant_md5": "a2e91bdfd830919800310ec7719f8c70",
            "volume_id": "Fedora-S-dvd-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "5603833086ba6694dec3868384799eaa59ef96742b97acf1df0484eec953cccb",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-boot-x86_64-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454838796,
            "size": 470810624,
            "bootable": true,
            "implant_md5": "13abba9f8b6621d7668bf37f6307924b",
            "volume_id": "Fedora-S-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "1c0fc6ceb263a9f6af711c0b6c941c4cc77a3da3b6b06b96be7047f1befb3a23",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-boot-i386-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454838384,
            "size": 529530880,
            "bootable": true,
            "implant_md5": "16d1c165e3920e1741f63d96154f646e",
            "volume_id": "Fedora-S-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "fddefb28378898a91414141d3b92e9f34ea7f554e001872add40becbbdb2c130",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-dvd-i386-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "dvd",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454841937,
            "size": 1951399936,
            "bootable": true,
            "implant_md5": "0eb22abf7280d209fc3e23006e42dfa2",
            "volume_id": "Fedora-S-dvd-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "f3e5117bef0b63d5e0a37d29b52315421923c1aea68f69a07baabedba99d8a46",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Server-dvd-armhfp-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "dvd",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "armhfp",
            "mtime": 1454842154,
            "size": 1768208384,
            "bootable": true,
            "implant_md5": "3916f4e6836e82e4404d5e8ebff5eae0",
            "volume_id": "Fedora-S-dvd-armhfp-24",
            "md5": null,
            "sha1": null,
            "sha256": "51b01bc72694b5fe500f6829941537a2a7d026808a86a03b7eef865a52eb35b6",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Workstation-boot-x86_64-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1454838920,
            "size": 468713472,
            "bootable": true,
            "implant_md5": "38d0b5e426c42f3f45e5b957896a2731",
            "volume_id": "Fedora-WS-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "276807b4e5cba0010ba397a606e987e3243c99f6771dbe5eb3f57e17da919f24",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Workstation-boot-i386-24-20160207.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1454838643,
            "size": 528482304,
            "bootable": true,
            "implant_md5": "0a1d98eefffab02b92fb67711d428357",
            "volume_id": "Fedora-WS-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "e4c2892039e4f6173000f578bbe7c0b09ece40c9a87c641940c6887511d43579",
            "composes": [
                "Fedora-24-20160207.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Cloud-boot-x86_64-24-20160224.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1456346378,
            "size": 471859200,
            "bootable": true,
            "implant_md5": "95661b37214ae715e030c1e34cc3063e",
            "volume_id": "Fedora-C-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "258fa933e4fa31e04681e73f2711e554876f9a6486ba4300b847377f5b565d81",
            "composes": [
                "Fedora-24-20160224.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Cloud-boot-i386-24-20160224.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1456344895,
            "size": 536870912,
            "bootable": true,
            "implant_md5": "a85c3ee48f1606ec248841b3bfa88324",
            "volume_id": "Fedora-C-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "73358f108e323e8422e484d5d5dc40a9ee9c562ea0c9a60f0ca4aae88b0e4e52",
            "composes": [
                "Fedora-24-20160224.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Everything-boot-x86_64-24-20160224.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1456346390,
            "size": 472907776,
            "bootable": true,
            "implant_md5": "cea42feb3fc335b92f691979bd019257",
            "volume_id": "Fedora-E-boot-x86_64-24",
            "md5": null,
            "sha1": null,
            "sha256": "9c87dc09f3916601dc3d9174fd4e2072676d6755b93cbe7be009efa5fc5f40f5",
            "composes": [
                "Fedora-24-20160224.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Everything-boot-i386-24-20160224.n.0.iso",
            "image_format": "iso",
            "image_type": "boot",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "i386",
            "mtime": 1456344975,
            "size": 536870912,
            "bootable": true,
            "implant_md5": "02aa68236c0b68fc51134ed5bb8ac038",
            "volume_id": "Fedora-E-boot-i386-24",
            "md5": null,
            "sha1": null,
            "sha256": "299a5896a1a22c4202b8a8768a19d0b60a4686e1eaf2a7175d65024e382a5101",
            "composes": [
                "Fedora-24-20160224.n.0"
            ],
            "subvariant": ""
        },
        {
            "file_name": "Fedora-Live-Games-x86_64-Rawhide-20160224.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1456353922,
            "size": 4270850048,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "e4aee77edc69fb6a109538e15d30ae478374f367610250328890a42984654f4a",
            "composes": [
                "Fedora-24-20160224.n.0"
            ],
            "subvariant": ""
        }
    ]
}