Images

API Reference

GPU Droplets

Images

Create a Custom Image

client.gpuDroplets.images.create(ImageCreateParams { description, distribution, name, 3 more } body, RequestOptionsoptions?): ImageCreateResponse { image }

post/v2/images

Delete an Image

client.gpuDroplets.images.delete(numberimageID, RequestOptionsoptions?): void

delete/v2/images/{image_id}

List All Images

client.gpuDroplets.images.list(ImageListParams { page, per_page, _private, 2 more } query?, RequestOptionsoptions?): ImageListResponse { images, meta, links }

get/v2/images

Retrieve an Existing Image

client.gpuDroplets.images.retrieve(number | stringimageID, RequestOptionsoptions?): ImageRetrieveResponse { image }

get/v2/images/{image_id}

Update an Image

client.gpuDroplets.images.update(numberimageID, ImageUpdateParams { description, distribution, name } body, RequestOptionsoptions?): ImageUpdateResponse { image }

put/v2/images/{image_id}

ImagesActions

Initiate an Image Action

client.gpuDroplets.images.actions.create(numberimageID, ActionCreateParamsbody, RequestOptionsoptions?): Action { id, completed_at, region, 6 more }

post/v2/images/{image_id}/actions

List All Actions for an Image

client.gpuDroplets.images.actions.list(numberimageID, RequestOptionsoptions?): ActionListResponse { meta, actions, links }

get/v2/images/{image_id}/actions

Retrieve an Existing Action

client.gpuDroplets.images.actions.retrieve(numberactionID, ActionRetrieveParams { image_id } params, RequestOptionsoptions?): Action { id, completed_at, region, 6 more }

get/v2/images/{image_id}/actions/{action_id}