Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DomainService

Hierarchy

  • DomainService

Index

Constructors

constructor

Methods

createDomain

  • Create a new domain on your account

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    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>

deleteDomain

  • deleteDomain(domainName: string): Promise<void>
  • Delete a specific domain from your account

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    await client.domains.deleteDomain('example.com');

    Parameters

    • domainName: string

    Returns Promise<void>

getAllDomains

  • getAllDomains(): Promise<Domain[]>
  • Get a list of all the domains on your account

    Example

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

    Returns Promise<Domain[]>

getExistingDomain

  • getExistingDomain(domainName: string): Promise<Domain>
  • Get information about a specific domain

    Example

    import { DigitalOcean } from 'digitalocean-deno';
    
    const client = new DigitalOcean('your-api-key');
    const domain = await client.domains.getExistingDomain('example.com');

    Parameters

    • domainName: string

    Returns Promise<Domain>

Generated using TypeDoc