Skip to main content

List Images

GET https://infrahub-api.nexgencloud.com/v1/core/images​

Retrieves a grouped list of all available operating system (OS) images across regions and types. The results include system-defined images as well as custom images created from snapshots. Image metadata such as type, version, region, and storage size is returned. Optional parameters allow you to filter by region, paginate results, or search by image name or ID.

For an overview of available images in Hyperstack, see Images.


Query String Parameters​

region string  optional​

Filter results to a specific region.

include_public boolean  optional​

Whether to include public images. Defaults to true.

search string or integer  optional​

Search by image name or ID.

page integer  optional​

Page number for paginated results.

per_page integer  optional​

Number of results per page.


Attributes​

status boolean​

Indicates if the request was successful.

message string​

Description of the operation outcome.

images array of objects​

Grouped by region and type.

Show child attributes
region_name string​

Region name.

green_status string​

Indicates the green status of the region (e.g., GREEN, NOT_GREEN).

type string​

Type or OS family (e.g., Ubuntu).

logo string​

URL to a logo representing the image type.

images array​

List of image objects.

Show child attributes
id integer​

The image ID.

name string​

Display name of the image.

region_name string​

Region where the image is available.

type string​

Operating system type.

version string​

Version of the OS.

size integer​

Size in bytes.

display_size string​

Human-readable size (e.g., 100.0 GB).

description string​

Optional image description.

snapshot object​

Optional. Present if the image is created from a snapshot. For more information, see Custom Images.

Show child attributes
id integer​

Snapshot ID.

name string​

Snapshot name.

created_at date-time​

Timestamp when the snapshot was created.

size number​

Size in GB.

display_size string​

Human-readable size (e.g., 100 GB).

is_public boolean​

Whether the image is publicly accessible.

created_at date-time​

Timestamp when the image was created.

labels array​

Optional labels associated with the image.

Refer to the Image Object for more detail.


Example Request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/core/images" \
 -H "accept: application/json" \
 -H "api_key: YOUR_API_KEY"
Example Response
{
  "status": true,
  "message": "Getting images successful",
  "images": [
    {
      "region_name": "US-1",
      "green_status": "NOT_GREEN",
      "type": "Ubuntu",
      "logo": "https://api.nexgencloud.com:8080/hyperstack-os-logos/ubuntu.svg",
      "images": [
        {
          "id": 300,
          "name": "Ubuntu Server 22.04 LTS R535 CUDA 12.2 with Docker",
          "region_name": "US-1",
          "type": "Ubuntu",
          "version": "Server 22.04 LTS R535 CUDA 12.2 with Docker",
          "size": 107374182400,
          "display_size": "100.0 GB",
          "description": "",
          "snapshot": {
            "id": 94,
            "name": "test-snapshot",
            "created_at": "2025-06-03T12:54:15",
            "size": 100,
            "display_size": "100 GB"
          },
          "is_public": true,
          "created_at": "2025-02-03T06:56:51",
          "labels": []
        }
      ]
    }
  ]
}

Returns​

Returns grouped OS images by region and type, each containing an array of image objects.



Back to Top​