Class MonitorManager

Index

Constructors

Properties

Methods

_getMonitorObject create delete get getAll getAvailabilitySummary getResponseTimes update

Constructors

constructor

new MonitorManager(__namedParameters): MonitorManager
Parameters
- __namedParameters: BetterUptime
Returns MonitorManager
- Defined in monitors/MonitorManager.ts:16

Properties

`Private` apiClient

apiClient: AxiosInstance

Methods

_getMonitorObject

_getMonitorObject(monitor): Monitor
Parameters
- monitor: BasicMonitor
Returns Monitor
- Defined in monitors/MonitorManager.ts:173

create

create(newMonitor): Promise<Monitor>
Returns a newly created monitor or validation errors.
Parameters
- newMonitor: NewMonitor
  The new monitor object
Returns Promise<Monitor>
The created object
- Defined in monitors/MonitorManager.ts:120

delete

delete(monitor_id): Promise<boolean>
Permanently deletes an existing monitor.
Parameters
- monitor_id: string
  Monitor ID you want to remove
Returns Promise<boolean>
True if success
- Defined in monitors/MonitorManager.ts:167

get

get(monitor_id): Promise<Monitor>
Returns a single monitor.
Parameters
- monitor_id: string
  The ID of the monitor you want to get
Returns Promise<Monitor>
Single monitor
- Defined in monitors/MonitorManager.ts:49

getAll

getAll(query?): Promise<Monitor[]>
Returns list of all your monitors.
Parameters
- query: GetAllParams = {}
Returns Promise<Monitor[]>
Array of monitors
- Defined in monitors/MonitorManager.ts:25

getAvailabilitySummary

getAvailabilitySummary(query): Promise<MonitorAvailabilitySummary>
Returns availability summary for a specific monitor.
Parameters
- query: GetAvailabilitySummary
Returns Promise<MonitorAvailabilitySummary>
Single monitor response times object
- Defined in monitors/MonitorManager.ts:91

getResponseTimes

getResponseTimes(monitor_id): Promise<MonitorResponseTimes>
Returns the response times for a monitor (last 24h).
Parameters
- monitor_id: string
  The ID of the monitor you want to get
Returns Promise<MonitorResponseTimes>
Single monitor response times object
- Defined in monitors/MonitorManager.ts:69

update

update(monitor_id, newMonitor): Promise<Monitor>
Update existing monitor configuration. Send only the parameters you wish to change
Parameters
- monitor_id: string
  Monitor ID you want to change
- newMonitor: Partial<NewMonitor>
  Object with all changed properties
Returns Promise<Monitor>
The updated monitor
- Defined in monitors/MonitorManager.ts:141

Generated using TypeDoc