Creates a new monitor group in your UptimeRobot account for organizing monitors into logical collections. Groups can be used for filtering, reporting, and managing monitors collectively.
Monitor group configuration object (see MonitorGroupPayload interface for all options)
Promise that resolves to the created MonitorGroup object with assigned ID
// Create a new monitor group
const group = await service.monitorGroups.create({
name: 'Production APIs',
description: 'Critical production API endpoints'
});
https://uptimerobot.com/api/v3/#post-/monitor-groups Official API Documentation
Removes a monitor group completely from your UptimeRobot account. This action cannot be undone. Monitors in the group will not be deleted, but will be removed from the group.
Monitor group ID (number or string)
Promise that resolves to true when deletion is successful
// Delete a monitor group
const success = await service.monitorGroups.delete((12345);
if (success) {
console.log('Monitor group deleted successfully');
}
https://uptimerobot.com/api/v3/#delete-/monitor-groups/-id- Official API Documentation
Fetches complete information about an individual monitor group by ID, including name, description, associated monitors, and group statistics.
Monitor group ID (number or string)
Promise that resolves to the MonitorGroup object
// Get monitor group details
const group = await service.monitorGroups.get(12345);
console.log(`Group "${group.name}" contains ${group.monitorCount} monitors`);
https://uptimerobot.com/api/v3/#get-/monitor-groups/-id- Official API Documentation
Retrieves a list of monitor groups from your UptimeRobot account. Monitor groups help organize monitors into logical collections for easier management and reporting. Results are paginated using cursor-based pagination.
Optionalfilter: { cursor?: number }Query string parameters passed to the API
Optionalcursor?: numberPagination cursor for next page
OptionalreturnFullResponse: falseReturns MonitorGroup[] by default, or URFullResponse<MonitorGroup> if returnFullResponse is true.
// Get all monitor groups
const groups = await service.monitorGroups.list();
// Paginate through results
const page1 = await service.monitorGroups.list();
const page2 = await service.monitorGroups.list({ cursor: 123456789 });
// Get full response for pagination
const response = await service.monitorGroups.list({}, true);
const nextUrl = new URL(response.nextLink);
const nextCursorVal = nextUrl.searchParams.get('cursor');
console.log(nextCursorVal);
https://uptimerobot.com/api/v3/#get-/monitor-groups Official API Documentation
Retrieves a list of monitor groups from your UptimeRobot account. Monitor groups help organize monitors into logical collections for easier management and reporting. Results are paginated using cursor-based pagination.
Query string parameters passed to the API
Optionalcursor?: numberPagination cursor for next page
Returns MonitorGroup[] by default, or URFullResponse<MonitorGroup> if returnFullResponse is true.
// Get all monitor groups
const groups = await service.monitorGroups.list();
// Paginate through results
const page1 = await service.monitorGroups.list();
const page2 = await service.monitorGroups.list({ cursor: 123456789 });
// Get full response for pagination
const response = await service.monitorGroups.list({}, true);
const nextUrl = new URL(response.nextLink);
const nextCursorVal = nextUrl.searchParams.get('cursor');
console.log(nextCursorVal);
https://uptimerobot.com/api/v3/#get-/monitor-groups Official API Documentation
Modifies the settings of an existing monitor group. Note: This endpoint only updates the name of the monitor group. Other properties cannot be changed after creation.
Monitor group ID (number or string)
Monitor group configuration updates (partial MonitorGroupPayload object)
Promise that resolves to the updated MonitorGroup object
// Update monitor group name
const updatedGroup = await service.monitorGroups.update((12345, {
name: 'Updated Production APIs'
});
https://uptimerobot.com/api/v3/#patch-/monitor-groups/-id- Official API Documentation
Creates a new MonitorGroups client.
The request client to use.
Client for the Monitor Groups API.
See
https://uptimerobot.com/api/v3 Official API Documentation
Since
1.0.0