Images
A set of operations for creating images and retrieving information about your existing ones.
| Endpoint Name | URL | Description |
|---|---|---|
| Create Image | POST /core/snapshots/ | Create an image from a snapshot. |
| List Images | GET /core/images | List all images. |
| Retrieve Image | GET /core/images/ | Retrieve a specific image. |
| Delete Image | DELETE /core/images/ | Deletes a specified image. |
The Image object
The response to image endpoint API requests includes the image object, which provides comprehensive details about your images.
Attributes of the Image object
status boolean
Indicates the success or failure of the operation. In this case, it is set to true, indicating that the operation has been successful.
message string
A message confirming the status of the operation.
image object
An object containing details about the image.
Show child attributes
id integer
The unique identifier for the image.
name string
The name of the image.
region_name string
The name of the image's region.
type string
The type of image.
version string
The version of the image.
size integer
The size of the image in bytes.
display_size string
The human-friendly size of the image.
description string
The description of the image.
is_public boolean
If the image is public or private to an organisation. Images created from a snapshot are always private.
created_at string
The timestamp when the image was created.
labels array of strings
Labels to help identify the image.
{
"status": true,
"message": "string",
"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": []
}
}