API Reference

Retrieves alarms

get
https://alarms.api.eu1.scalar.zf.com/v1/alarms

Retrieves a list of alarms.

📘

The rate limit for this API is large.

Query Params
date-time
required

Parameter to specify the date and time to filter upon the last alarms.

string

Optional parameter represents the base64 converted token to be used as a cursor for fetching next set of alarms in ascending order.

assetIds
array of uuids
length ≤ 50

Optional parameter represents IDs of an asset to filter upon. If not provided, all alarms for all assets within the organization are retrieved.
The maximum count of IDs allowed is 50.

assetIds
int32
1 to 10000
Defaults to 100

Optional parameter to represent a limit for fetching the alarms ranging between 1 and 10000. If not set, the default value 100 is used.

Responses

401

Failure code. Unauthorized access.

403

Failure code. Forbidden access.

429

Failure code. Too many incoming requests.

Updated 6 months ago

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

Updated 6 months ago

Did this page help you?