APIs.io Engineering Platform · Schema
aaa_filters
Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| actions | array | Usage depends on specific alert type |
| affected_asns | array | Used for configuring radar_notification |
| affected_components | array | Used for configuring incident_alert |
| affected_locations | array | Used for configuring radar_notification |
| airport_code | array | Used for configuring maintenance_event_notification |
| alert_trigger_preferences | array | Usage depends on specific alert type |
| alert_trigger_preferences_value | array | Usage depends on specific alert type |
| enabled | array | Used for configuring load_balancing_pool_enablement_alert |
| environment | array | Used for configuring pages_event_alert |
| event | array | Used for configuring pages_event_alert |
| event_source | array | Used for configuring load_balancing_health_alert |
| event_type | array | Usage depends on specific alert type |
| group_by | array | Usage depends on specific alert type |
| health_check_id | array | Used for configuring health_check_status_notification |
| incident_impact | array | Used for configuring incident_alert |
| input_id | array | Used for configuring stream_live_notifications |
| limit | array | Used for configuring billing_usage_alert |
| logo_tag | array | Used for configuring logo_match_alert |
| megabits_per_second | array | Used for configuring advanced_ddos_attack_l4_alert |
| new_health | array | Used for configuring load_balancing_health_alert |
| new_status | array | Used for configuring tunnel_health_event |
| packets_per_second | array | Used for configuring advanced_ddos_attack_l4_alert |
| pool_id | array | Usage depends on specific alert type |
| pop_name | array | Usage depends on specific alert type |
| product | array | Used for configuring billing_usage_alert |
| project_id | array | Used for configuring pages_event_alert |
| protocol | array | Used for configuring advanced_ddos_attack_l4_alert |
| query_tag | array | Usage depends on specific alert type |
| requests_per_second | array | Used for configuring advanced_ddos_attack_l7_alert |
| selectors | array | Usage depends on specific alert type |
| services | array | Used for configuring clickhouse_alert_fw_ent_anomaly |
| slo | array | Usage depends on specific alert type |
| status | array | Used for configuring health_check_status_notification |
| target_hostname | array | Used for configuring advanced_ddos_attack_l7_alert |
| target_ip | array | Used for configuring advanced_ddos_attack_l4_alert |
| target_zone_name | array | Used for configuring advanced_ddos_attack_l7_alert |
| traffic_exclusions | array | Used for configuring traffic_anomalies_alert |
| tunnel_id | array | Used for configuring tunnel_health_event |
| tunnel_name | array | Usage depends on specific alert type |
| where | array | Usage depends on specific alert type |
| zones | array | Usage depends on specific alert type |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/aaa_filters",
"title": "aaa_filters",
"description": "Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.",
"example": {
"slo": [
"99.9"
]
},
"properties": {
"actions": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"affected_asns": {
"description": "Used for configuring radar_notification",
"items": {
"type": "string"
},
"type": "array"
},
"affected_components": {
"description": "Used for configuring incident_alert",
"example": "4c231tkdlpcl",
"items": {
"type": "string"
},
"type": "array"
},
"affected_locations": {
"description": "Used for configuring radar_notification",
"items": {
"type": "string"
},
"type": "array"
},
"airport_code": {
"description": "Used for configuring maintenance_event_notification",
"items": {
"type": "string"
},
"type": "array"
},
"alert_trigger_preferences": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"alert_trigger_preferences_value": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Used for configuring load_balancing_pool_enablement_alert",
"items": {
"minItems": 1,
"type": "string"
},
"type": "array"
},
"environment": {
"description": "Used for configuring pages_event_alert",
"items": {
"minItems": 1,
"type": "string"
},
"type": "array"
},
"event": {
"description": "Used for configuring pages_event_alert",
"items": {
"minItems": 1,
"type": "string"
},
"type": "array"
},
"event_source": {
"description": "Used for configuring load_balancing_health_alert",
"items": {
"type": "string"
},
"type": "array"
},
"event_type": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"group_by": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"health_check_id": {
"description": "Used for configuring health_check_status_notification",
"items": {
"type": "string"
},
"type": "array"
},
"incident_impact": {
"description": "Used for configuring incident_alert",
"items": {
"enum": [
"INCIDENT_IMPACT_NONE",
"INCIDENT_IMPACT_MINOR",
"INCIDENT_IMPACT_MAJOR",
"INCIDENT_IMPACT_CRITICAL"
],
"type": "string"
},
"type": "array"
},
"input_id": {
"description": "Used for configuring stream_live_notifications",
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"description": "Used for configuring billing_usage_alert",
"items": {
"minItems": 1,
"type": "string"
},
"type": "array"
},
"logo_tag": {
"description": "Used for configuring logo_match_alert",
"items": {
"type": "string"
},
"type": "array"
},
"megabits_per_second": {
"description": "Used for configuring advanced_ddos_attack_l4_alert",
"items": {
"type": "string"
},
"type": "array"
},
"new_health": {
"description": "Used for configuring load_balancing_health_alert",
"items": {
"type": "string"
},
"type": "array"
},
"new_status": {
"description": "Used for configuring tunnel_health_event",
"items": {
"type": "string"
},
"type": "array"
},
"packets_per_second": {
"description": "Used for configuring advanced_ddos_attack_l4_alert",
"items": {
"type": "string"
},
"type": "array"
},
"pool_id": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"pop_name": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"product": {
"description": "Used for configuring billing_usage_alert",
"items": {
"minItems": 1,
"type": "string"
},
"type": "array"
},
"project_id": {
"description": "Used for configuring pages_event_alert",
"items": {
"minItems": 1,
"type": "string"
},
"type": "array"
},
"protocol": {
"description": "Used for configuring advanced_ddos_attack_l4_alert",
"items": {
"type": "string"
},
"type": "array"
},
"query_tag": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"requests_per_second": {
"description": "Used for configuring advanced_ddos_attack_l7_alert",
"items": {
"type": "string"
},
"type": "array"
},
"selectors": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"services": {
"description": "Used for configuring clickhouse_alert_fw_ent_anomaly",
"items": {
"minItems": 1,
"type": "string"
},
"type": "array"
},
"slo": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "Used for configuring health_check_status_notification",
"items": {
"minItems": 1,
"type": "string"
},
"type": "array"
},
"target_hostname": {
"description": "Used for configuring advanced_ddos_attack_l7_alert",
"items": {
"type": "string"
},
"type": "array"
},
"target_ip": {
"description": "Used for configuring advanced_ddos_attack_l4_alert",
"items": {
"type": "string"
},
"type": "array"
},
"target_zone_name": {
"description": "Used for configuring advanced_ddos_attack_l7_alert",
"items": {
"type": "string"
},
"type": "array"
},
"traffic_exclusions": {
"description": "Used for configuring traffic_anomalies_alert",
"items": {
"enum": [
"security_events"
],
"maxItems": 1,
"type": "string"
},
"type": "array"
},
"tunnel_id": {
"description": "Used for configuring tunnel_health_event",
"items": {
"type": "string"
},
"type": "array"
},
"tunnel_name": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"where": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
},
"zones": {
"description": "Usage depends on specific alert type",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}