DOdomaintools
Iris Detect

Retrieves monitors and monitor IDs for an account.

get/v1/iris-detect/monitors/

Request

Query parameters

app_namestring

A short identifier, code, or handle.

Appliance, module, or playbook, or any combination of these.

app_partnerstring

A short identifier, code, or handle.

Your product name.

app_versionstring

A short identifier, code, or handle.

Version of your integration/connector.

integer

Relative offset in seconds before the current UTC time.

Must be between -1 (1 second ago) and -432000 (5 days ago).

OR
string date-time

ISO 8601 datetime in UTC format with no milliseconds or timezone offset. Format: YYYY-MM-DDTHH:MM:SSZ.

The timestamp must represent a point between 1 second ago and 5 days ago, relative to the current UTC time.

Filters counts to include only those generated since the specified ISO-8601 date-time. This parameter is conditionally required if include_counts is set to true. Example: 2022-02-10T00:00:00Z

include_countsboolean

An optional boolean flag that enables a specific feature or response extension when set to true. If false or omitted, the feature is ignored.

If set to true, the response will include counts for new, watched, changed, and escalated domains for each monitor.

limitinteger

Specifies the maximum number of monitors to retrieve. The default is 500. The maximum is restricted to 100 if include_counts=true.

offsetinteger

Specifies the starting point for the result set, used for paginating when the number of results exceeds the 'limit'. An offset of 0 starts from the first result.

order'asc' | 'desc'

Specifies the sort order for the results, either ascending or descending. Used in conjunction with the 'sort' parameter. Defaults to desc.

sort[]'term' | 'created_date' | 'domain_counts_changed' | 'domain_counts_discovered'

Provides options for sorting the monitor list.

Response

OK. A list of monitors was successfully retrieved.

total_countinteger
offsetinteger
limitinteger

Changes

No recorded changes to this operation across all 1 revision of this API.