{"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 filters query parameter. Filter for the attributes of the alerts.","properties":{"status":{"type":"integer","enum":[1,2,3,4],"description":"The status of the alert. The supported status types are:\n- 1 (Active)\n- 2 (Dismissed)\n- 3 (Resolved)\n- 4 (Archived)","example":1,"$$ref":"#/components/schemas/statusAlert"},"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"},"created_after":{"description":"Filter for the alerts in the collection that the system created after the timestamp.\nProvide a date and time (ISO 8601) using the YYYY-MM-DD HH:MM:SS format.\n**Note:** You cannot use the `created_after` query parameter with the `time_range` filter.","type":"string","format":"date-time","example":"2024-01-01T00:00:00Z","$$ref":"#/components/schemas/created_after"},"modified_at":{"type":"string","format":"date-time","description":"The time and date (ISO 8601 timestamp) when the system last modified the alert.","example":"2025-01-01T00:00:00Z","$$ref":"#/components/schemas/modifiedAtAlert"},"alert_name":{"type":"string","description":"The name of the alert.","example":"Production VPN Tunnel Alert","$$ref":"#/components/schemas/nameAlert"},"pattern_search":{"description":"Provide a search pattern to query for by the alert name, alert rule name, or alert rule category name.","type":"string","example":"Network Tunnel","$$ref":"#/components/schemas/pattern_search"},"only_active_alerts_count":{"description":"Specify whether to query for the count of the active alerts only.","type":"boolean","default":false,"example":true,"$$ref":"#/components/schemas/only_active_alerts_count"},"time_range":{"type":"object","description":"The start and end times that the system uses to filter the alerts in the collection.","properties":{"start_time":{"type":"string","format":"date-time","description":"The time and date (ISO 8601 timestamp) that begins the time range. The system uses\nthe time range to filter for alerts in the collection.\nUse the 'YYYY-MM-DD HH:MM:SS' format.","example":"2024-01-01 00:00:00"},"end_time":{"type":"string","format":"date-time","description":"The time and date (ISO 8601 timestamp) that ends the time range. The system uses\nthe time range to filter for alerts in the collection.\nUse the 'YYYY-MM-DD HH:MM:SS' format.","example":"2024-12-31 23:59:59"}},"example":{"start_time":"2024-01-01 00:00:00","end_time":"2024-12-31 23:59:59"},"$$ref":"#/components/schemas/time_range"},"include_context":{"description":"Include the context field in each alert response. The context contains additional metadata about the alert.","type":"boolean","default":false,"example":true,"$$ref":"#/components/schemas/include_context"}},"$$ref":"#/components/schemas/filtersAlertObject","title":"filtersAlertObject"}}