Alarms

Get list of alarm rules

Returns list of alarm rules

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
name
string

Filter alarm rules by name.

description
string

Filter alarm rules by description.

is_active
string

Filter active alarm rules.

created_on_gt
string

Filter alarm rules created after a given timestamp.

created_on_lt
string

Filter alarm rules created before a given timestamp.

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/alarmrules/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Creates instance of alarm rules

Returns instance of alarm rules

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: application/json
id
string <uuid>
enterprise
required
string <uuid>
devices
Array of any <string>
groups
Array of strings
name
required
string
description
string
metric
required
string
required
object
action_emails
Array of strings <email>
actions
Array of strings
alert_channels
Array of strings
created_on
string <date-time>
updated_on
string <date-time>
is_active
boolean
realert_interval
required
integer
repeat_times
integer
trigger_count
integer
daily_trigger_count
integer
Responses
201

successful operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

500

Internal server error

post/api/v1/enterprise/{enterprise_id}/alarmrules/
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": [
    ],
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": {
    },
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}

Get instance of alarm rule

Returns instance of alarm rule

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alarm_id
required
string

A UUID string identifying the alarm ruleset.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": {
    },
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}

Update alarm rules

Return instance of alarm rules

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alarm_id
required
string

A UUID string identifying the alarm ruleset.

Request Body schema: application/json
id
string <uuid>
enterprise
required
string <uuid>
devices
Array of any <string>
groups
Array of strings
name
required
string
description
string
metric
required
string
required
object
action_emails
Array of strings <email>
actions
Array of strings
alert_channels
Array of strings
created_on
string <date-time>
updated_on
string <date-time>
is_active
boolean
realert_interval
required
integer
repeat_times
integer
trigger_count
integer
daily_trigger_count
integer
Responses
200

successful operation

400

Invalid request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

put/api/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": [
    ],
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": {
    },
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}

Partially updates alarm rules

Returns instance of alarm rules

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alarm_id
required
string

A UUID string identifying the alarm ruleset.

Request Body schema: application/json
id
string <uuid>
enterprise
required
string <uuid>
devices
Array of any <string>
groups
Array of strings
name
required
string
description
string
metric
required
string
required
object
action_emails
Array of strings <email>
actions
Array of strings
alert_channels
Array of strings
created_on
string <date-time>
updated_on
string <date-time>
is_active
boolean
realert_interval
required
integer
repeat_times
integer
trigger_count
integer
daily_trigger_count
integer
Responses
200

successful operation

400

Invalid request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

patch/api/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": [
    ],
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": {
    },
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}

Deletes alarm rule

Empty response

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alarm_id
required
string

A UUID string identifying the alarm ruleset.

Responses
204

The resource was deleted successfully.

400

Invalid request.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/api/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}

Get history of alarm rule

Returns instance of alarm rule history

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alarm_id
required
string

A UUID string identifying the alarm ruleset.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/alarmhistory/
Response samples
application/json
{
  • "device_name": "string",
  • "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
  • "group_id": [
    ],
  • "group_name": "string",
  • "alert_time": "2019-08-24T14:15:22Z",
  • "latest_seen": "2019-08-24T14:15:22Z"
}