Class MonitorsBulk

Bulk monitor operations for a single monitor group (pause all, start all, update all).

Use via Monitors.bulk.

See

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

Index

Constructors

Methods

pause start update

Constructors

constructor

new MonitorsBulk(client: RequestClient): MonitorsBulk
Parameters
- client: RequestClient
Returns MonitorsBulk

Methods

pause

pause(groupId: idField): Promise<BulkOperationResponse>
Pause all monitors in the given monitor group.
Parameters
- groupId: idField
  Monitor group ID
Returns Promise<BulkOperationResponse>
See
https://uptimerobot.com/api/v3/#post-/monitors/bulk/pause

start

start(groupId: idField): Promise<BulkOperationResponse>
Start (resume) all paused monitors in the given monitor group.
Parameters
- groupId: idField
  Monitor group ID
Returns Promise<BulkOperationResponse>
See
https://uptimerobot.com/api/v3/#post-/monitors/bulk/start

update

update(payload: BulkMonitorUpdatePayload): Promise<BulkOperationResponse>
Apply shared setting updates to all monitors in the given monitor group.
Parameters
- payload: BulkMonitorUpdatePayload
Returns Promise<BulkOperationResponse>
See
https://uptimerobot.com/api/v3/#post-/monitors/bulk/update