Class ImageService

Delete an image

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
await client.images.deleteImage('image-id');

Get all application images

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const images = await client.images.getAllApplicationImages();
// Paginate application images, 10 per page, starting on page 1
images = await client.images.getAllApplicationImages(10, 1);

Get all distribution images

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const images = await client.images.getAllDistributionImages();
// Paginate images, 10 per page, starting on page 1
images = await client.images.getAllDistributionImages(10, 1);

Get all images on account

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const images = await client.images.getAllImages();

Get information about an image

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const image = await client.images.getExistingImage('image-id');

Get information about an image by image slug

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const image = await client.images.getExistingImageBySlug('image-slug');

Get all actions that have been executed on an image

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const actions = await client.images.getImageActions('image-id');

Get the private images of a user

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const images = await client.images.getUserImages();
// Paginate user images, 10 per page, starting on page 1
images = await client.images.getUserImages(10, 1);

Update an image name

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const image = await client.images.updateImageName('image-id', 'New Image Name');