Skip to main content

Retrieve Image Details

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

Retrieve details of a image. For more information about images, click here.


Path parameters​

id integer  required​

The unique identifier of the image to retrieve.


Attributes​

status integer​

HTTP status code indicating the result of the request.

message string​

A description of the status of the request.

image object​

An object containing details about the specified image.

For descriptions of the fields within the image 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/{id}" \
 -H "accept: application/json"\
 -H "api_key: YOUR API KEY"
Response
{
  "status": true,
  "message": "Image details retrieved successfully.",
  "image": {
    "id": 56,
    "name": "string",
    "region_name": "string",
    "type": "string",
    "version": "string",
    "size": 0,
    "display_size": "string",
    "description": "string",
    "is_public": false,
    "created_at": "1970-01-01T00:00:00.000Z",
    "labels": []
  }
}

Returns​

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


Back to top​