Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FloatingIPService

Hierarchy

  • FloatingIPService

Index

Constructors

constructor

Methods

createFloatingIPForDroplet

  • createFloatingIPForDroplet(dropletId: string): Promise<FloatingIP>
  • Create a new Floating IP assigned to a Droplet

    Example

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

    Parameters

    • dropletId: string

    Returns Promise<FloatingIP>

createFloatingIPForRegion

  • createFloatingIPForRegion(region: string): Promise<FloatingIP>
  • Create a Floating IP reserved to a Region

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const floatingIP =
       await client.floatingIPs.createFloatingIPForRegion('nyc3');

    Parameters

    • region: string

    Returns Promise<FloatingIP>

deleteFloatingIP

  • deleteFloatingIP(floatingIPAddress: string): Promise<void>
  • Delete an existing Floating IP and remove it from your account

    Example

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

    Parameters

    • floatingIPAddress: string

    Returns Promise<void>

getAllFloatingIPs

  • List all of the Floating IPs available on your account

    Example

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

    Returns Promise<FloatingIP>

getExistingFloatingIP

  • getExistingFloatingIP(floatingIPAddress: string): Promise<FloatingIP>
  • Show information about an existing Floating IP

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const floatingIP =
       await client.floatingIPs.getExistingFloatingIP('1.2.3.4');

    Parameters

    • floatingIPAddress: string

    Returns Promise<FloatingIP>

Generated using TypeDoc