Object describing a monitor.

Hierarchy

  • Monitor

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
created?: Date

Timestamp of the monitor creation.

creator?: v1.Creator

Object describing the creator of the shared element.

deleted?: Date

Whether or not the monitor is deleted. (Always null)

id?: number

ID of this monitor.

matchingDowntimes?: MatchingDowntime[]

A list of active v1 downtimes that match this monitor.

message?: string

A message to include with notifications for this monitor.

modified?: Date

Last timestamp when the monitor was edited.

multi?: boolean

Whether or not the monitor is broken down on different groups.

name?: string

The monitor name.

options?: MonitorOptions

List of options associated with your monitor.

overallState?: MonitorOverallStates

The different states your monitor can be in.

priority?: number

Integer from 1 (high) to 5 (low) indicating alert severity.

query: string

The monitor query.

restrictedRoles?: string[]

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

state?: MonitorState

Wrapper object with the different monitor states.

tags?: string[]

Tags associated to your monitor.

The type of the monitor. For more information about type, see the monitor options docs.

Generated using TypeDoc