Skip to content

Get list of alarm rules
Stable

Request

Returns list of alarm rules

Security
apiKey
Path
enterprise_idstringrequired

A UUID string identifying this enterprise.

Query
namestring

Filter alarm rules by name.

descriptionstring

Filter alarm rules by description.

is_activeboolean

Filter active alarm rules.

created_on_gtstring

Filter alarm rules created after a given timestamp.

created_on_ltstring

Filter alarm rules created before a given timestamp.

limitinteger

Number of results to return per page.

Default:20
offsetinteger

Return results from this index.

Default:0
cURL
curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/alarmrules/?name=string&description=string&is_active=true&created_on_gt=string&created_on_lt=string&limit=20&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
countintegerrequired
nextstring or null, (url)
previousstring or null, (url)
resultsArray of objects(AlarmRule)required
Response
{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}