Skip to main content

Retrieve Image Details

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

Retrieves detailed information about a specific image by its unique ID. To obtain the image ID, use the List Images API.


Path parameters​

id integer   Required​

The unique identifier of the image for which to retrieve details.


Attributes​

status boolean​

Indicates the result of the request to retrieve image details. true signifies success, while false indicates an encountered error.

message string​

A description of the status of the request.

image object​

An object containing details about the specified image.

Show child attributes
id integer​

Unique identifier for the image.

name string​

Name of the image.

region_name string​

Region where the image is stored.

type string​

Type of the image (e.g., Snapshot, linux, custom).

version string​

Version label or identifier for the image.

size integer​

Raw size of the image in bytes.

display_size string​

Human-readable size of the image.

description string|null​

Optional description of the image.

is_public boolean​

Whether the image is publicly accessible.

created_at string​

ISO 8601 timestamp of when the image was created.

labels array[string]​

Optional labels associated with the image.

snapshot object​

Present only if the image was created from a snapshot.

Show child attributes
id integer​

ID of the snapshot.

name string​

Name of the snapshot.

created_at string​

Timestamp when the snapshot was created.

size number​

Size of the snapshot in GB.

display_size string​

Human-readable size of the snapshot.

Array of associated virtual machines, if any. Always present in the response.

Show child attributes

Currently an empty object structure; schema to be defined in future revisions.

Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/core/images/{id}" \
 -H "accept: application/json"\
 -H "api_key: YOUR API KEY"
  • To authenticate Infrahub API requests, add an api_key header to your API request that contains an API Key.
Response
{
  "status": true,
  "message": "Image details retrieved successfully.",
  "image": {
    "id": 439,
    "name": "daring-einstein",
    "region_name": "CANADA-1",
    "type": "Snapshot",
    "version": "test-snapshot",
    "size": 107374182400,
    "display_size": "100.0 GB",
    "description": null,
    "snapshot": {
      "id": 94,
      "name": "test-snapshot",
      "created_at": "2025-06-03T12:54:15",
      "size": 100,
      "display_size": "100 GB"
    },
    "is_public": false,
    "created_at": "2025-06-03T12:54:15",
    "related_vms": []
  }
}

Returns​

Returns the image object containing the details of the specified image. If details on the specified image are not retrieved, an error will be returned.


Back to top​