Image

List 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.

get/core/images

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/images
  • Auth: API key in header api_key

Query parameters

regionstring

Filter results to the specified region.

include_publicboolean

When true, public images are included in the response alongside organization images.

searchstring

Search query to filter images by name

pageinteger

Page number for pagination

per_pageinteger

Number of Images per page

Response

Retrieval of images list successful.

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

Example response

{
  "status": true,
  "message": "Getting images successful",
  "images": [
    {
      "region_name": "US-1",
      "type": "Ubuntu",
      "logo": "https://api.nexgencloud.com:8080/hyperstack-os-logos/ubuntu.svg",
      "images": [
        {
          "id": 1402,
          "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 GiB",
          "is_public": true
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.