Iris API Reference

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.

Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!