uptime-robot-v3
    Preparing search index...

    Class Users

    Client for the Users API.

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

    1.0.0

    Index

    Other

    User

    • Fetches a list of alert contacts (email, SMS, webhook, etc.) configured in the user's account. These contacts can be used for monitor notifications and alerts.

      Returns Promise<AlertContact[]>

      Promise that resolves to an array of AlertContact objects

      When API request fails

      // Get all alert contacts
      const contacts = await service.users.getAlertContacts();
      contacts.forEach(contact => {
      console.log(`${contact.type}: ${contact.value} (${contact.status})`);
      });

      1.0.0

    • Fetches detailed information about all alert contacts including their usage statistics, associated monitors, and configuration details. Provides more comprehensive data than getAlertContacts().

      Returns Promise<UserAlertsResponse[]>

      Promise that resolves to an array of UserAlertsResponse objects with extended details

      When API request fails

      // Get detailed alert contact information
      const detailedContacts = await service.users.getAllAlertContacts();
      detailedContacts.forEach(contact => {
      console.log(`${contact.type}: ${contact.value}`);
      console.log(`Associated monitors: ${contact.monitorCount}`);
      });

      1.0.0

    • Fetches detailed information about the authenticated user's UptimeRobot account, including email, plan details, monitor limits, and account status.

      Returns Promise<User>

      Promise that resolves to the User object containing account details

      When authentication fails or API request fails

      // Get current user info
      const user = await service.users.me();
      console.log(`Account: ${user.email} (${user.planType})`);
      console.log(`Monitor limit: ${user.monitorLimit}`);

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

      1.0.0