Class MonitorGroupManager

Index

Constructors

Properties

apiClient betterUptime

Methods

create delete get getAll getAllMonitors update

Constructors

constructor

new MonitorGroupManager(betterUptime): MonitorGroupManager
Parameters
- betterUptime: BetterUptime
Returns MonitorGroupManager
- Defined in monitor-groups/MonitorGroupManager.ts:10

Properties

`Private` apiClient

apiClient: AxiosInstance

`Private` betterUptime

betterUptime: BetterUptime

Methods

create

create(newMonitorGroup): Promise<any>
Returns either a newly created monitor group, or validation errors.
Parameters
- newMonitorGroup: any
Returns Promise<any>
- Defined in monitor-groups/MonitorGroupManager.ts:74

delete

delete(monitor_group_id): Promise<boolean>
Permanently deletes an existing monitor group.
Parameters
- monitor_group_id: string
  Monitor group ID you want to remove
Returns Promise<boolean>
True if success
- Defined in monitor-groups/MonitorGroupManager.ts:119

get

get(monitor_group_id): Promise<any>
Returns a single monitor group by ID.
Parameters
- monitor_group_id: string
Returns Promise<any>
- Defined in monitor-groups/MonitorGroupManager.ts:32

getAll

getAll(__namedParameters?): Promise<any>
Returns a list of all your monitor groups.
Parameters
- __namedParameters: {
  page?: number;
  } = {}
  - Optional page?: number
Returns Promise<any>
- Defined in monitor-groups/MonitorGroupManager.ts:18

getAllMonitors

getAllMonitors(monitor_group_id): Promise<Monitor[]>
Returns monitors belonging to the given monitor group.
Parameters
- monitor_group_id: string
  The ID of the monitor group you want to get
Returns Promise<Monitor[]>
Array of monitors
- Defined in monitor-groups/MonitorGroupManager.ts:54

update

update(monitor_group_id, newMonitorGroup): Promise<any>
Update the attributes of an existing monitor group. Send only the parameters you wish to change
Parameters
- monitor_group_id: string
  Monitor Group ID you want to change
- newMonitorGroup: Partial<any>
Returns Promise<any>
- Defined in monitor-groups/MonitorGroupManager.ts:93

Generated using TypeDoc