Class CdnService

Hierarchy

  • CdnService

Constructors

Methods

  • Delete an existing CDN endpoint

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const endpoint = await client.cdn.deleteEndpoint('endpoint-id');

    Parameters

    • id: string

    Returns Promise<void>

  • List all of the CDN endpoints available on your account

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const endpoints = await client.cdn.getAllEndpoints();

    Returns Promise<CdnEndpoint[]>

  • Get an existing CDN endpoint

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const endpoint = await client.cdn.getExistingEndpoint('endpoint-id');

    Parameters

    • id: string

    Returns Promise<CdnEndpoint>

  • Purge cached content from a CDN endpoint

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const files = [
    'assets/img/hero.png',
    'assets/css/*'
    ];
    const endpoint = await client.cdn.purgeEndpointCache('endpoint-id', files);

    Parameters

    • id: string
    • files: string[]

    Returns Promise<void>

  • Update the ttl of an existing CDN endpoint

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const endpoint = await client.cdn.updateEndpoint('endpoint-id', 1800);

    Parameters

    • id: string
    • ttl: number

    Returns Promise<CdnEndpoint>

Generated using TypeDoc