Class TagService

Hierarchy

  • TagService

Constructors

Methods

  • Create new tag

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const tag = await client.tags.createTag('new-tag');

    Parameters

    • name: string

    Returns Promise<Tag>

  • Delete a tag by tag name

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    await client.tags.deleteTag('tag-name');

    Parameters

    • tagName: string

    Returns Promise<void>

  • Get a specific existing tag by name

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const tag = await client.tags.getTagByName('tag-name');

    Parameters

    • tagName: string

    Returns Promise<Tag>

  • Get all tags on the account

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const tags = await client.tags.getTags();

    Returns Promise<Tag[]>

  • Remove tag from specified resources

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const resources = [
    'droplet-id-1',
    'droplet-id-2',
    'droplet-id-3'
    ];
    await client.tags.removeTagFromResources('tag-name', resources);

    Parameters

    • tagName: string
    • resourceIds: string[]

    Returns Promise<void>

  • Add tag to specified resources

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const resources = [
    'droplet-id-1',
    'droplet-id-2',
    'droplet-id-3'
    ];
    await client.tags.tagResources('tag-name', resources);

    Parameters

    • tagName: string
    • resourceIds: string[]

    Returns Promise<void>

Generated using TypeDoc