Class FloatingIPService

Hierarchy

  • FloatingIPService

Constructors

Methods

  • Create a new Floating IP assigned to a Droplet

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const floatingIP =
    await client.floatingIPs.createFloatingIPForDroplet('droplet-id');

    Parameters

    • dropletId: string

    Returns Promise<FloatingIP>

  • Create a Floating IP reserved to a Region

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const floatingIP =
    await client.floatingIPs.createFloatingIPForRegion('nyc3');

    Parameters

    • region: string

    Returns Promise<FloatingIP>

  • Delete an existing Floating IP and remove it from your account

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    await client.floatingIPs.deleteFloatingIP('1.2.3.4');

    Parameters

    • floatingIPAddress: string

    Returns Promise<void>

  • Show information about an existing Floating IP

    Example

    import { DigitalOcean } from 'digitalocean-js';

    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