uptime-robot-v3
    Preparing search index...

    Class Tags

    Client for the Tags API.

    https://uptimerobot.com/api/v3 Official API Documentation

    1.0.0

    Index

    Other

    Tags

    • Removes a custom tag completely from your UptimeRobot account. This action cannot be undone. The tag will be removed from all monitors that currently use it.

      Parameters

      • id: idField

        Tag ID (number or string)

      Returns Promise<boolean>

      Promise that resolves to true when deletion is successful

      When tag ID is not found

      When API request fails

      // Delete a tag
      const success = await service.tags.delete(12345);
      if (success) {
      console.log('Tag deleted successfully');
      }

      1.0.0

    • Retrieves a list of custom tags from your UptimeRobot account. Tags can be used to categorize and filter monitors for better organization and management. Results are paginated using cursor-based pagination.

      Parameters

      • Optionalfilter: { cursor?: number }

        Query string parameters passed to the API

        • Optionalcursor?: number

          Pagination cursor for next page

      • OptionalreturnFullResponse: false

      Returns Promise<UserTag[]>

      Returns UserTag[] by default, or URFullResponse<UserTag> if returnFullResponse is true.

      When cursor is negative

      // Get all user tags
      const tags = await service.tags.list();
      tags.forEach(tag => {
      console.log(`Tag: ${tag.name} (used by ${tag.monitorCount} monitors)`);
      });

      // Paginate through results
      const page1 = await service.tags.list();
      const page2 = await service.tags.list({ cursor: 123456789 });

      // Get full response for pagination
      const response = await service.tags.list({}, true);
      const nextUrl = new URL(response.nextLink);
      const nextCursorVal = nextUrl.searchParams.get('cursor');
      console.log(nextCursorVal);

      https://uptimerobot.com/api/v3/#get-/tags Official API Documentation

      1.0.0

    • Retrieves a list of custom tags from your UptimeRobot account. Tags can be used to categorize and filter monitors for better organization and management. Results are paginated using cursor-based pagination.

      Parameters

      • filter: { cursor?: number }

        Query string parameters passed to the API

        • Optionalcursor?: number

          Pagination cursor for next page

      • returnFullResponse: true

      Returns Promise<URFullResponse<UserTag>>

      Returns UserTag[] by default, or URFullResponse<UserTag> if returnFullResponse is true.

      When cursor is negative

      // Get all user tags
      const tags = await service.tags.list();
      tags.forEach(tag => {
      console.log(`Tag: ${tag.name} (used by ${tag.monitorCount} monitors)`);
      });

      // Paginate through results
      const page1 = await service.tags.list();
      const page2 = await service.tags.list({ cursor: 123456789 });

      // Get full response for pagination
      const response = await service.tags.list({}, true);
      const nextUrl = new URL(response.nextLink);
      const nextCursorVal = nextUrl.searchParams.get('cursor');
      console.log(nextCursorVal);

      https://uptimerobot.com/api/v3/#get-/tags Official API Documentation

      1.0.0