Skip to main content

List Images

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

Returns a list of all available operating system (OS) images, providing details about each image's corresponding virtual machine operating system. Include the optional region parameter in the query string of the request to specifically return OS images from the designated region. For more information on OS images, click here.


Query string parameters​

region string  optional​

Search for the name of the region.

include_public boolean  optional​

Denotes if public images should also be retrieved, defaults to false.

search string or integer  optional​

Search for the name of the image to retrieve it.

page integer  optional​

The page number to retrieve images from.

per_page integer  optional​

Specify the number of images to return per page.


Attributes​

status boolean​

Indicates the result of the request to retrieve a list of images. true signifies success, while false indicates an error.

message string​

A description of the status of the request.

images array of objects​

An array of images objects, each containing details about an image.

For descriptions of the fields within the images object returned in response to your request, please refer to the documentation here.


Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/core/images" \
 -H "accept: application/json"\
 -H "api_key: YOUR API KEY"
Response
{
  "status": true,
  "message": "string",
  "images": [
    {
      "id": 0,
      "name": "string",
      "region_name": "string",
      "type": "string",
      "version": "string",
      "size": 0,
      "display_size": "string",
      "description": "string",
      "is_public": false,
      "created_at": "2024-11-29T12:43:26",
      "labels": ["string"]
    }
  ],
  "count": 0,
  "page": 0,
  "page_size": 0
}

Returns​

Returns a list of your images as image objects, each containing details about the image.



Back to top​