{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/e7c4374c-388b-3f3f-bd38-63991a559765","info":{"title":"Cisco Secure Access Alerting API","version":"1.0.0","description":"Manage the alert rules in the organization and monitor the alerts generated by the alert rules.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Alert Rules"},{"name":"Alerts"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/admin/alert-rules-overview.md","uri":"secure-access-api-reference-alerting-overview"}},"openapi":"3.0.0","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"admin.alertrules:read":"Read Alert Rules","admin.alertrules:write":"Write Alert Rules","admin.alerts:read":"Read Alerts","admin.alerts:write":"Write Alerts"}}}}}},"spec":{"type":"object","description":"The properties of the alert rule.","properties":{"id":{"type":"integer","description":"The unique identifier of the alert rule.","example":42,"$$ref":"#/components/schemas/idAlertRule"},"name":{"type":"string","maxLength":255,"description":"The unique name of the alert rule.","example":"Production VPN Tunnel Alert","$$ref":"#/components/schemas/nameAlertRule"},"description":{"type":"string","maxLength":100,"description":"The description of the alert rule.","example":"Alert when production VPN tunnel disconnects","$$ref":"#/components/schemas/descriptionAlertRule"},"severity":{"type":"integer","enum":[1,2,3,4],"description":"The severity of the alert. The supported severity levels are:\n- 1 (High)\n- 2 (Medium)\n- 3 (Low)\n- 4 (Info)","example":1,"$$ref":"#/components/schemas/severityAlert"},"status":{"type":"integer","enum":[1,2],"description":"The status of the alert rule. The supported status types are:\n- 1 (Enabled)\n- 2 (Disabled)","example":1,"$$ref":"#/components/schemas/statusAlertRule"},"rule_type_id":{"type":"integer","description":"The identifier of the rule type.","example":1,"$$ref":"#/components/schemas/ruleTypeId"},"notification_info":{"type":"array","description":"List of notification configurations for this rule","items":{"type":"object","description":"The properties of the notification for the alert rule.","properties":{"type":{"type":"string","enum":["email","webhook"],"description":"The type of the notification for the alert rule.","example":"webhook","$$ref":"#/components/schemas/notificationTypeAll"},"recipients":{"type":"array","description":"The list of email recipients configured in the alert rule to receive the notification.","minItems":1,"maxItems":50,"items":{"type":"string","format":"email","description":"An email recipient for the notification."},"example":["admin@company.com","ops@company.com"]},"webhook_ids":{"type":"array","description":"The list of unique identifiers for the Webhooks configured on the alert rule.","items":{"type":"string","description":"The unique identifier for the Webhook ID.","example":"1abcde"}}},"$$ref":"#/components/schemas/notificationInfoAlertRule"}},"organization_id":{"type":"integer","description":"The unique identifier of the organization.","example":12345,"$$ref":"#/components/schemas/organizationId"},"conditions":{"type":"object","description":"The conditions that trigger the type of notification.","properties":{"match_type":{"type":"string","enum":["all","any",""],"description":"Choose from one of the accepted conditions: `all` (AND), `any` (OR), or ''.","example":"all"},"rows":{"type":"array","description":"The list of conditions that the system uses to evaluate the alert rule.","items":{"type":"object","description":"The conditions that define the alert rule.","required":["field","value"],"properties":{"field":{"type":"string","description":"The name of the condition."},"value":{"type":"string","description":"The canonical name of the geographical region for the data center where the notification occurs."}}}}},"$$ref":"#/components/schemas/conditionsAlertRule"},"created_at":{"type":"string","format":"date-time","description":"The time and date (ISO 8601 timestamp) when the system created the alert rule.","example":"2025-01-01T00:00:00Z","$$ref":"#/components/schemas/createdAtAlertRule"},"modified_at":{"type":"string","format":"date-time","description":"The time and date (ISO 8601 timestamp) when the system last modified the alert rule.","example":"2025-01-01T00:00:00Z","$$ref":"#/components/schemas/modifiedAtAlertRule"}},"$$ref":"#/components/schemas/AlertRule","title":"AlertRule"}}