Get Health Alert Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Health Alert Model","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get health alerts.**","operationId":"getHealthAlertModel","parameters":[{"description":"Various filter criteria can be specified using the format \u003ccode\u003estartTime:start_time_in_secs;endTime:end_time_in_secs;deviceUUIDs:List_of_device_uuids;status:List_of_statuses;moduleIDs:List_of_moduleIDs.\u003c/code\u003e\u003cbr/\u003e\u003cbr/\u003e\u003ccode\u003estartTime\u003c/code\u003e -- start time in unix format - startTime and endTime should be specified together\u003cbr/\u003e\u003ccode\u003eendTime\u003c/code\u003e -- end time in unix format - startTime and endTime should be specified together\u003cbr/\u003e\u003ccode\u003edeviceUUIDs\u003c/code\u003e -- List of device UUIDs (UUID is 0 for Firewall Management Center).\u003cbr/\u003e\u003ccode\u003estatus\u003c/code\u003e -- List of status codes to filter delimited by comma, e.g. green,red,yellow.\u003cbr/\u003e\u003ccode\u003emoduleIDs\u003c/code\u003e -- List of module ids to filter, delimited by comma.\u003cbr/\u003e.","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","description":"An object representing the health alert.","properties":{"description":{"type":"string"},"details":{"type":"string"},"deviceUUID":{"description":"UUID of the device on which the alert is raised","type":"string"},"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"moduleID":{"description":"ID of the module, it is one of APPLICATION_BYPASS, CARD_RESET, CPU, DISK_USAGE, EVENT_STREAM, HEALTH_MONITOR, HEARTBEAT, INTERFACE, HARDWARE_ALARM, POWER_SUPPLY, LIC, LIC_MONITOR, LINKSTATE_PROPAGATION, MEMORY_USAGE, PEP, PROCESS, DISCOVERY_HEALTH, HOST_LIMIT, RRD_SERVER, SENSOR_HUB, INTRUSION_FILE_STATS, TEST, TIME_SYNC, TIME_SERIES_DATA_MONITOR, URLFILTER, SECURITY_INTELLIGENCE, AMP_FOR_ENDPOINTS, USER_AGENT, SMART_LICENSE, VPN, HIGH_AVAILABILITY, DATABASE, PLATFORM_FAULTS, THREAT_DATA_UPDATES, REALM, ISE, SNORT_IDENTITY_MEMORY_USAGE, MALWARE, DISK_STATUS, BACKLOG, STATIC_ANALYSIS, CLUSTER, INLINELINK_ALARM, RECONFIG_DETECTION, CONNECTIONS, CRITICAL_PROCESS, DEPLOYED_CONFIGURATION, SNORT_STATS FTD_HA, NTPD and CERTIFICATE_MONITORING","enum":["APPLICATION_BYPASS","CARD_RESET","CPU","DISK_USAGE","EVENT_STREAM","HEALTH_MONITOR","HEARTBEAT","INTERFACE","PATHMONITORING","HARDWARE_ALARM","POWER_SUPPLY","LICENSE","LINKSTATE_PROPAGATION","MEMORY_USAGE","PEP","PROCESS","DISCOVERY_HEALTH","HOST_LIMIT","RRD_SERVER","APPLIANCE_HEARTBEAT","INTRUSION_FILE_STATS","TEST","TIME_SYNC","TIME_SERIES_DATA_MONITOR","URLFILTER","SECURITY_INTELLIGENCE","AMP_FOR_ENDPOINTS","USER_AGENT","SMART_LICENSE","VPN","HIGH_AVAILABILITY","DATABASE","PLATFORM_FAULTS","THREAT_DATA_UPDATES","REALM","ISE","SNORT_IDENTITY_MEMORY_USAGE","AMP_FOR_FIREPOWER_STATUS","DISK_STATUS","BACKLOG","LOCAL_MALWARE_ANALYSIS","CLUSTER","INLINELINK_ALARM","RECONFIG_DETECTION","CONNECTIONS","CRITICAL_PROCESS","DEPLOYED_CONFIGURATION","SNORT_STATS","FTD_HA","FILE_SYSTEM_INTEGRITY_CHECK","ASP_DROP","HIT_COUNT","NTP_SERVER","ROUTING_STATS","UNRESOLVED_GROUPS_MONITOR","CONN_STATUS_SSE","CONN_STATUS_AMP","FLOW_OFFLOAD","CHASSIS_STATUS_FTD","ADVANCED_SNORT_STATS","OUT_OF_BAND_CHANGES","HM_LTP","FTD_CONFIG_RESOURCE_UTILISATION","SYBASE_STATUS","MYSQL","MONETDB","VPN_STATS","RABBITMQ","EVENT","HARDWARE_STATISTICS_FMC","X_TLS_COUNTER","CSDAC_STATUS","THREAT_GRID_MAP","WEB_SERVER_STATS","NTPD","SD_WAN_MONITORING","PASSIVE_IDENTITY_AGENT_MONITOR","CERTIFICATE_MONITORING","HM_TALOSAGENT","IDENTITY_PROCESS_STATUS","FXOS_HEALTH"],"type":"string"},"moduleUUID":{"description":"UUID of the module on which the alert is raised","type":"string"},"name":{"type":"string"},"params":{"type":"string"},"status":{"description":"Status of the alert, it is one of GREEN, RED, YELLOW, DISABLED and RECOVERED","enum":["GREEN","DISABLED","RECOVERED","RED","ERROR","YELLOW","FAILED"],"type":"string"},"timestamp":{"description":"Time in seconds at which the alert is raised, timestamp is in unix format","format":"int32","type":"integer"},"type":{"description":"Type of the alert. This will always be Alert","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/HealthAlertModel"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/HealthAlertModelListContainer"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Health"],"__originalOperationId":"getHealthAlertModel","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/alerts"}}