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

{
    "count": 282273,
    "next": "https://pdc.fedoraproject.org/rest_api/v1/images/?page=12893",
    "previous": "https://pdc.fedoraproject.org/rest_api/v1/images/?page=12891",
    "results": [
        {
            "file_name": "Fedora-Xfce-Rawhide-20231204.n.0.aarch64.raw.xz",
            "image_format": "raw.xz",
            "image_type": "raw-xz",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701679043,
            "size": 3722283220,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "5bd1a69df7d31f6551fa7d6e062600859cd5fb86bcaa6c19cf602718ee7a1055",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Xfce"
        },
        {
            "file_name": "Fedora-Minimal-Rawhide-20231204.n.0.aarch64.raw.xz",
            "image_format": "raw.xz",
            "image_type": "raw-xz",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701678313,
            "size": 1243373080,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "e35e97eb0245237e85d77f10db2fe6c723090af997ccf5fcdfdc8f70be4cb077",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Minimal"
        },
        {
            "file_name": "Fedora-LXQt-Rawhide-20231204.n.0.aarch64.raw.xz",
            "image_format": "raw.xz",
            "image_type": "raw-xz",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701679083,
            "size": 3292630120,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "55f71779ba26a83d60f4f5e08729c761ac9876324733801bd6e4b4bc23dabe0e",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "LXQt"
        },
        {
            "file_name": "Fedora-KDE-Rawhide-20231204.n.0.aarch64.raw.xz",
            "image_format": "raw.xz",
            "image_type": "raw-xz",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701679173,
            "size": 5492439120,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "424329efe5d87f431f859d1b9ceac0a0b742486ce3e7cdc4f7415419a926a6e5",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "KDE"
        },
        {
            "file_name": "Fedora-LXDE-Live-x86_64-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701677614,
            "size": 1693603840,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "301438e0458517d8f6110885807e0bf36930818866456dd2804b107b74365ebc",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "LXDE"
        },
        {
            "file_name": "Fedora-SoaS-Live-x86_64-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701678300,
            "size": 1372665856,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "a072f847fac73695e90ef122722a1a83edece5c0cf679e30bf778e2ecf680316",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "SoaS"
        },
        {
            "file_name": "Fedora-MATE_Compiz-Live-x86_64-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701677870,
            "size": 2366083072,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "96a2a0e916a54c57af1d2758c7922c575e2d98d467cb4c5662ec72bf613f3a29",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Mate"
        },
        {
            "file_name": "Fedora-Cinnamon-Live-x86_64-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701679018,
            "size": 2455988224,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "18dc83f7c940ce40d709937a3e2b5b518adb069f70fae03845fb28749e88edff",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Cinnamon"
        },
        {
            "file_name": "Fedora-Xfce-Live-x86_64-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701679014,
            "size": 1791762432,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "1fb064dc1b1e06714ce9a378c4aecc914bd8840eaee64de53670af0f25b95715",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Xfce"
        },
        {
            "file_name": "Fedora-KDE-Live-x86_64-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701679170,
            "size": 2642927616,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "f7a9e476eb421ce5ae73b4d764cc5552bc85f919d1a84bace357a0aa3057f5da",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "KDE"
        },
        {
            "file_name": "Fedora-Sway-Live-x86_64-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701679012,
            "size": 1589989376,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "08e420de66069a32a47443c1ed0824966bb8a08db52695da9b262cda87018d0a",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Sway"
        },
        {
            "file_name": "Fedora-i3-Live-x86_64-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701678065,
            "size": 1548435456,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "479b833d0e28a3c080e4b8d92e93cf85b5bec29ed280474b5f02e03218105adf",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "i3"
        },
        {
            "file_name": "Fedora-Budgie-Live-x86_64-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701679016,
            "size": 2077108224,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "d8a181f554a3104a7b34954a0e40793a21cb3685486c7864f044397fa3976bec",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Budgie"
        },
        {
            "file_name": "Fedora-Workstation-Live-osb-Rawhide-20231204.n.0.aarch64.iso",
            "image_format": "iso",
            "image_type": "live-osbuild",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701679490,
            "size": 2488428544,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "aa5995c7b4c59b1f4894e02411b74db25fac210062ed6b5e72be8e0726355805",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Workstation"
        },
        {
            "file_name": "Fedora-Workstation-Rawhide-20231204.n.0.aarch64.raw.xz",
            "image_format": "raw.xz",
            "image_type": "raw-xz",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701680874,
            "size": 4490004460,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "58a0a3366a428589690d4d42ef7eb1349de551049aa72a120fd30e5bec50c646",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Workstation"
        },
        {
            "file_name": "Fedora-Workstation-Live-osb-Rawhide-20231204.n.0.x86_64.iso",
            "image_format": "iso",
            "image_type": "live-osbuild",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701680063,
            "size": 2533359616,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "7d1525f3ab1974bc28d8cad860c4b0f7dd04df062aa5b799a85bf9481c1d7691",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Workstation"
        },
        {
            "file_name": "Fedora-Workstation-Live-x86_64-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "x86_64",
            "mtime": 1701679052,
            "size": 2208821248,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "7a3b0c8ee0420f3312bd3028401511090e5c39dd0fd13bb07ed130f57e2a7393",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Workstation"
        },
        {
            "file_name": "Fedora-Workstation-Live-ppc64le-Rawhide-20231204.n.0.iso",
            "image_format": "iso",
            "image_type": "live",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "ppc64le",
            "mtime": 1701679042,
            "size": 2160799744,
            "bootable": true,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "7475215ac4c14e63235971c55df56b7cc8c04aa48f1470e200877e7026cb8778",
            "composes": [
                "Fedora-Rawhide-20231204.n.0"
            ],
            "subvariant": "Workstation"
        },
        {
            "file_name": "Fedora-IoT-39.20231204.0-20231204.0.aarch64.raw.xz",
            "image_format": "raw.xz",
            "image_type": "raw-xz",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701705777,
            "size": 721718248,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "6edc81b70f245ddac245cc6cb6b7840a841aadc9894c16426070229f928fb569",
            "composes": [
                "Fedora-IoT-39-20231204.0"
            ],
            "subvariant": "IoT"
        },
        {
            "file_name": "Fedora-IoT-ostree-39.20231204.0-20231204.0.aarch64.iso",
            "image_format": "iso",
            "image_type": "dvd",
            "disc_number": 1,
            "disc_count": 1,
            "arch": "aarch64",
            "mtime": 1701706182,
            "size": 2422073344,
            "bootable": false,
            "implant_md5": null,
            "volume_id": null,
            "md5": null,
            "sha1": null,
            "sha256": "f725d2dc9f74844537236d81814757fd3eb0b778b04f03d0e54c812ad800915f",
            "composes": [
                "Fedora-IoT-39-20231204.0"
            ],
            "subvariant": "IoT"
        }
    ]
}