v1
latestOpenAPI 3.0.02026-07-249372139.7 KBAlerts
List Alerts
Returns a list of alerts that have been raised.
get/tasks
Query parameters
fields[]string[]
Will only return the fields specified from this parameter, multiple uses of the parameter required for multiple fields
Response
Example response
[
{
"ID": 7586,
"Environment": {
"ID": 18701,
"ServiceProviderID": 1,
"Name": "Contoso Nation",
"ShortName": "CN",
"Description": "Example Description",
"Status": 1,
"Visible": true,
"ExpiresOn": "2021-09-10T19:21:03.195Z",
"KeyRotation": 90,
"LastKeyRotation": "2021-09-10T19:21:03.195Z",
"Website": "contoso.com",
"CreatedOn": "2021-09-10T19:21:03.195Z",
"UpdatedOn": "2021-09-10T19:21:03.195Z",
"Tier": "Core"
},
"CommonID": "T20210920.00001",
"Name": "Alert Name",
"Description": "Alert Descrition ",
"Priority": {
"ID": 67,
"Entity": "Task",
"Table": "Priority",
"Name": "Critical",
"Visible": true,
"Reserved": "critical",
"CreatedOn": "2021-09-10T19:21:03.195Z"
},
"Source": "Roar",
"Rule": {
"ID": 1219,
"Name": "Alert Name",
"Title": "Alert Title",
"Body": "Body Content for alert with {{Metric Evaluation}}",
"DynamicContent": "Dynamic Content for alert with {{Metric Evaluation}}",
"Visible": true,
"CreatedOn": "2021-09-10T19:21:03.195Z",
"UpdatedOn": "2021-09-10T19:21:03.195Z"
},
"AutoClose": 1,
"Status": {
"ID": 14,
"Entity": "Task",
"Table": "Status",
"Name": "New",
"Description": "Work has not been initiated yet",
"Visible": true,
"Reserved": "new",
"CreatedOn": "2021-09-10T19:21:03.195Z"
},
"Inspector": {
"ID": 13,
"Name": "active-directory-inspector",
"Alias": "Active Directory",
"Published": true,
"Author": "Liongard, Inc.",
"ContactEmail": "support@liongard.com",
"Logo": "https://resources.static.liongard.com/images/active-directory-inspector.png",
"Icon": "https://resources.static.liongard.com/images/icons/microsoft-windows-icon.png",
"Description": "Inspects Active Directory, returning a wide variety of data including actionable summary information such as privileged users, security policies and much more.",
"HelpLink": "https://docs.liongard.com/docs/active-directory-inspection-setup",
"PublishedStatus": "production",
"InspectorCategory": "appservices",
"DefaultFrequency": {
"Type": "days",
"Interval": 1
},
"Constraints": {
"Tiers": [
"core"
],
"Platform": [
"windows"
],
"Frequency": {
"MaxIntervalType": "hours",
"MaxIntervalFrequency": 8
},
"AgentConstraint": [
"customer-on-prem"
],
"RecomendedAgent": "customer-on-prem"
},
"CreatedOn": "2021/09/10 19:21:03",
"UpdatedOn": "2021/09/10 19:21:03"
},
"Version": {
"ID": 26,
"Name": "1.0.1-20210824-921cf729",
"Discovers": {
"inspectors": [
"windows-inspector"
]
},
"CreatedOn": "2021/09/10 19:21:03",
"Checksum": "a877d8161295685275fd3"
},
"Timeline": {
"ID": 1294715,
"Status": "Completed",
"ChangeDetections": 3,
"Alerts": 2,
"CreatedOn": "2021/09/10 19:21:03",
"UpdatedOn": "2021/09/10 19:21:03",
"ScheduledAt": "2021/09/10 19:21:03",
"ProcessingAt": "2021/09/10 19:21:03",
"RunningAt": "2021/09/10 19:21:03",
"FinishedAt": "2021/09/10 19:21:03",
"PayloadSizeBytes": 202285
},
"Launchpoint": {
"ID": 18700,
"Alias": "Launchpoint Name",
"Config": "{\"AD_SERVER\":\"dfdfdfdfd\",\"SEARCH_BASE\":\"dfdfdfd\",\"TIMEOUT\":2,\"TRIMMED\":1}",
"TotalScheduledRuns": 1,
"TotalAdHocRuns": 3,
"NextScheduledFor": "2021/09/10 19:21:03",
"LastScheduledRun": "2021/09/10 19:21:03",
"LastAdHocRun": "2021/09/10 19:21:03",
"FreqType": "weeks",
"FreqInterval": 2,
"ActiveStart": "2021/09/10 19:21:03",
"ActiveEnd": "2021/09/10 19:21:03",
"Enabled": true,
"Visible": true,
"Status": "Active",
"CreatedOn": "2021/09/10 19:21:03",
"UpdatedOn": "2021/09/10 19:21:03",
"EnvironmentID": 8000
},
"Visible": true,
"CreatedOn": "2021-09-10T19:21:03.195Z"
}
]