Class DomainService

Hierarchy

  • DomainService

Constructors

Methods

  • Create a new domain on your account

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const request = {
    name: 'example.com',
    ip_address: '1.2.3.4'
    };
    const domain = await client.domains.createDomain(request);

    Parameters

    Returns Promise<Domain>

  • Delete a specific domain from your account

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    await client.domains.deleteDomain('example.com');

    Parameters

    • domainName: string

    Returns Promise<void>

  • Get a list of all the domains on your account

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const domains = await client.domains.getAllDomains();

    Returns Promise<Domain[]>

  • Get information about a specific domain

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const domain = await client.domains.getExistingDomain('example.com');

    Parameters

    • domainName: string

    Returns Promise<Domain>

Generated using TypeDoc