Skip to main content

Images

A set of operations for creating images and retrieving information about your existing ones.

Endpoint NameURLDescription
Create ImagePOST /core/snapshots/{id}/imageCreate an image from a snapshot.
List ImagesGET /core/imagesList all images.
Retrieve ImageGET /core/images/{id}Retrieve a specific image.
Delete ImageDELETE /core/images/{id}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 whether the request was successful.

message string​

A descriptive message about the result of the request.

image object​

Contains metadata about the image.

Show child attributes
id integer​

Unique identifier for the image.

name string​

Name of the image.

region_name string​

Region in which the image is available.

type string​

Operating system type (e.g., Ubuntu).

version string​

Detailed OS version information.

size integer​

Size of the image in bytes.

display_size string​

Human-readable representation of the image size (e.g., 100.0 GB).

description string​

Description of the image.

snapshot object​

If the image was created from a snapshot, this object provides related snapshot metadata.

Show child attributes
id integer​

Snapshot ID.

name string​

Name of the snapshot.

created_at date-time​

Timestamp of when the snapshot was created.

size number​

Size of the snapshot in GB.

display_size string​

Human-readable size (e.g., 100 GB).

For details on custom images from snapshots, see Custom Images.

is_public boolean​

Indicates whether the image is public or private.

created_at date-time​

Timestamp when the image was created.

labels array of objects​

Optional labels associated with the image.

Show child attributes
id integer​

The unique identifier for the label.

label string​

The label text.

The image object
{
  "status": true,
  "message": "Getting images successful",
  "image": {
    "id": 300,
    "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.0 GB",
    "description": "",
    "snapshot": {
      "id": 94,
      "name": "test-snapshot",
      "created_at": "2025-06-03T12:54:15",
      "size": 100,
      "display_size": "100 GB"
    },
    "is_public": true,
    "created_at": "2025-02-03T06:56:51",
    "labels": []
  }
}

Back to top​