Iris API Reference
Start typing to search…

Get all alert configurations

get https://iris.trackunit.com/api/alerts/v1/configurations

This API request can be used to get a paginated list of alert configurations.
Sort properties: createdAt, lastModifiedAt, name. When not set, default sorting is by createdAt."

➡️

OpenAPI Specification for the Alert API domain

Get the OpenAPI Specification (formerly Swagger), which is a standardized format that describes the functionalities, endpoints, parameters, and data models of this API in a JSON file here.

🚧

Handling of enums when generating a client

Be aware when integrating with this API that the enums specified in the OpenAPI Spec should be expected to expand without it being treated as a breaking change. This will for example occur when new alert types are added in the future.

This means that when generating a client for this API you should ensure that the client can handle unknown enum values by e.g. defaulting to an unknown enum value.

An example of how to handle this is how the OpenApi java client generator with the configuration parameter enumUnknownDefaultCase does it. See further documentation.

Query Params
int32
≥ 0
Defaults to 0

Zero-based page index (0..N)

int32
≥ 1
Defaults to 20

The size of the page to be returned

sort
array of strings

Sort order: property (ascending by default), +property (ascending), -property (descending).

sort
Headers
string
Defaults to SI
Responses

Response body
object
content
array of objects

The page content as a list.

content
object
assetFilter
object
required

Filter that the alert is applied to e.g. by groups, by assets or all fleet.

configurationDetails
object
required

Detail configuration of the alert.

date-time
required

Timestamp when the alert was created.

uuid
required

Id of the user created the alert.

string
required

EN-English; GE-German; DA-Danish; CS-Czech; NL-Dutch; FR-French; HU-Hungarian;
IT-Italian; NB-Norwegian; PL-Polish; PT-Portuguese; RU-Russian; RO-Romanian;
ES-Spanish; SV-Swedish; JA-Japanese; TH-Thai

EN DE DA CS NL FR FI HU IT NB PL PT RU RO ES SV JA TH

boolean
required
Active status of the alert configuration.
|Value|Description|
|-|-|
|**true**|Alert is active.|
|**false**|Alert is inactive.|
uuid
required

The id of the alert configuration.

date-time

Timestamp when the alert was last updated.

uuid

Id of the user last updated the alert.

string
required

Name of the alert.

subscribers
object

List of subscribers that receive notification when alert triggers.

int32

The number of the current page.

int32

The number of elements currently on this page.

int32

The size of the page.

int64

The total number of elements.

int32

The number of total pages.

Updated about 1 year ago

Did this page help you?
Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?