GET alerts/{alert_id}
Gets the alert matching the provided id. Available targets: SMS, email and webhook.
URL Parameters
Name | Description |
---|---|
alert_id | Alert identifier. Type: numeric. |
Request example
curl --request GET "https://api-asm1.apica.io/v3/alerts/334?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"
Response body model example and description
{ "id": 12345, "check_id": 12345, "severity": "E", "enabled": true, "targets": [ { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true } ], "target_groups": [ { "id": 12, "name": "Developers", "enabled": true, "targets": [ { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true } ] }, { "id": 12, "name": "Developers", "enabled": true, "targets": [ { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true } ] }, { "id": 12, "name": "Developers", "enabled": true, "targets": [ { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true } ] } ] }
Name | Type | Description |
---|---|---|
id | Integer |
The alert's numeric identity. |
check_id | Integer |
The numeric identifier of the check. |
severity | String |
The alert's severity. |
enabled | Boolean |
The alert is enabled. |
targets | Array |
Supported targets: SMS, email and webhooks. |
type | String |
The target's type. |
id | Integer |
The target's numeric identity. |
name | String |
The target's name. |
to | String |
The target's destination. |
enabled | Boolean |
The target is enable. |
target_groups | Array |
Groups of targets. |
id | Integer |
The target group's numeric identity. |
name | String |
The target group name. |
enabled | Boolean |
The target group is enable. |
targets | Array |
Targets in group. |
type | String |
The target's type. |
id | Integer |
The target's numeric identity. |
name | String |
The target's name. |
to | String |
The target's destination. |
enabled | Boolean |
The target is enable. |