Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DropletService

Hierarchy

  • DropletService

Index

Constructors

constructor

Methods

createMultipleDroplets

  • Create multiple droplets with the same specs but different names

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const request = {
      names: [
        'sub-01.example.com',
        'sub-02.example.com'
      ],
      region: 'nyc3',
      size: 's-1vcpu-1gb',
      image: 'ubuntu-16-04-x64',
      ssh_keys: null,
      backups: false,
      ipv6: true,
      user_data: null,
      private_networking: null,
      tags: [
        'web'
      ]
    };
    const droplets = await client.droplets.createMultipleDroplets(request);

    Parameters

    Returns Promise<Droplet[]>

createNewDroplet

  • Create a new droplet

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const request = {
      name: 'example.com',
      region: 'nyc3',
      size: 's-1vcpu-1gb',
      image: 'ubuntu-16-04-x64',
      ssh_keys: null,
      backups: false,
      ipv6: true,
      user_data: null,
      private_networking: null,
      volumes: null,
      tags: [
        'web'
      ]
    };
    const droplet = await client.droplets.createNewDroplet(request);

    Parameters

    Returns Promise<Droplet>

deleteDroplet

  • deleteDroplet(dropletId: number): Promise<void>
  • Delete a specific droplet by ID

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    await client.droplets.deleteDroplet('droplet-id');

    Parameters

    • dropletId: number

    Returns Promise<void>

deleteDropletsByTag

  • deleteDropletsByTag(tag: string): Promise<void>
  • Delete Droplets by a tag

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    await client.droplets.deleteDropletsByTag('tag');

    Parameters

    • tag: string

    Returns Promise<void>

getAllDroplets

  • getAllDroplets(): Promise<Droplet[]>
  • Get all droplets on the account

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const droplets = await client.droplets.getAllDroplets();

    Returns Promise<Droplet[]>

getAvailableKernelsForDroplet

  • getAvailableKernelsForDroplet(dropletId: number): Promise<Kernel[]>
  • Retrieve a list of all kernels available to a Droplet

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const kernels = await client.droplets.getAvailableKernelsForDroplet('droplet-id');

    Parameters

    • dropletId: number

    Returns Promise<Kernel[]>

getBackupsForDroplet

  • getBackupsForDroplet(dropletId: number): Promise<Backup[]>
  • Retrieve any backups associated with a Droplet

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const backups = await client.droplets.getBackupsForDroplet('droplet-id');

    Parameters

    • dropletId: number

    Returns Promise<Backup[]>

getDropletActions

  • getDropletActions(dropletId: number): Promise<Action[]>
  • Retrieve all actions that have been executed on a Droplet

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const actions = await client.droplets.getDropletActions('droplet-id');

    Parameters

    • dropletId: number

    Returns Promise<Action[]>

getDropletNeighbors

  • getDropletNeighbors(): Promise<Droplet[][]>
  • Retrieve a list of any Droplets that are running on the same physical hardware

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const droplets = await client.droplets.getDropletNeighbors();

    Returns Promise<Droplet[][]>

getDropletsByTag

  • getDropletsByTag(tag: string): Promise<Droplet[]>
  • Get all droplets on the account that has a given tag

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const droplets = await client.droplets.getDropletsByTag('tag-name');

    Parameters

    • tag: string

    Returns Promise<Droplet[]>

getExistingDroplet

  • getExistingDroplet(dropletId: number): Promise<Droplet>
  • Get a specific existing droplet by ID

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const droplet = await client.droplets.getExistingDroplet('droplet-id');

    Parameters

    • dropletId: number

    Returns Promise<Droplet>

getNeighborsForDroplet

  • getNeighborsForDroplet(dropletId: number): Promise<Droplet[]>
  • Retrieve a list of Droplets that are running on the same physical server

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const droplets = await client.droplets.getNeighborsForDroplet('droplet-id');

    Parameters

    • dropletId: number

    Returns Promise<Droplet[]>

getSnapshotsForDroplet

  • getSnapshotsForDroplet(dropletId: number): Promise<Snapshot[]>
  • Retrieve the snapshots that have been created from a Droplet

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const snapshots = await client.droplets.getSnapshotsForDroplet('droplet-id');

    Parameters

    • dropletId: number

    Returns Promise<Snapshot[]>

Generated using TypeDoc