Class: Monitor

NS1.Monitor

Class representing monitors / monitoring jobs in NS1.

Constructor

new Monitor()

Source:

Extends

Methods

(static) jobtypes()

Returns job types xxxf Monitor.
Source:
Returns:
Promise

(static) regions()

Returns region keys available to Monitors.
Source:
Returns:
Promise

create_resource_path() → {String}

Overrideable method to provide non-standard "PUT" behavior on creating new records. E.g. Zones require info in the URI where Data Sources don't.
Overrides:
Source:
Returns:
Type
String

destroy() → {Promise}

Destroys an object on the server w/ the delete HTTP verb.
Inherited From:
Source:
Returns:
Type
Promise

get_resource_path() → {String}

Defines the path to posting changes & getting details on a single resource. Method is required to be overriden within child classes as most paths will require info pertaining to the individual resource's attributes.
Overrides:
Source:
Returns:
Type
String

history(args)

Returns history of monitor object.
Parameters:
Name Type Description
args Object Arguments to be supplied to refine the request, see https://ns1.com/api/#history-get for details
Source:
Returns:
Promise

metrics(args)

Returns metrics of monitor object.
Parameters:
Name Type Description
args Object Arguments to be supplied to refine the request, see https://ns1.com/api/#metrics-get for details
Source:
Returns:
Promise

save() → {Promise}

Saves an object on the server.
Inherited From:
Source:
Returns:
Type
Promise

update(attributes) → {Promise}

Updates an object w/ the provided attributes.
Parameters:
Name Type Description
attributes Object
Inherited From:
Source:
Returns:
Type
Promise