Retrieve

API Reference

GPU Droplets

Images

Retrieve an Existing Image

gpu_droplets.images.retrieve(Union[int, str]image_id) -> ImageRetrieveResponse

get/v2/images/{image_id}

To retrieve information about an image, send a GET request to /v2/images/$IDENTIFIER.

ParametersExpand Collapse

image_id: Union[int, str]

Accepts one of the following:

ImageIDUnionMember0 = int

ImageIDUnionMember1 = str

ReturnsExpand Collapse

class ImageRetrieveResponse: …

image: Image

HTTPPython

from gradient import Gradient

client = Gradient()
image = client.gpu_droplets.images.retrieve(
    0,
)
print(image.image)

200 example

{
  "image": {
    "created_at": "2020-05-04T22:23:02Z",
    "description": " ",
    "distribution": "Ubuntu",
    "error_message": " ",
    "min_disk_size": 20,
    "name": "Nifty New Snapshot",
    "public": true,
    "regions": [
      "nyc1",
      "nyc2"
    ],
    "size_gigabytes": 2.34,
    "slug": "nifty1",
    "status": "NEW",
    "tags": [
      "base-image",
      "prod"
    ],
    "type": "snapshot"
  }
}

Returns Examples

200 example

{
  "image": {
    "created_at": "2020-05-04T22:23:02Z",
    "description": " ",
    "distribution": "Ubuntu",
    "error_message": " ",
    "min_disk_size": 20,
    "name": "Nifty New Snapshot",
    "public": true,
    "regions": [
      "nyc1",
      "nyc2"
    ],
    "size_gigabytes": 2.34,
    "slug": "nifty1",
    "status": "NEW",
    "tags": [
      "base-image",
      "prod"
    ],
    "type": "snapshot"
  }
}