...
Access to the Feed requires a unique “API Key” provided by AppArmor. The API Key is a randomized string of text that is used as a parameter to all requests. Please contact AppArmor Support, or your AppArmor representative for information about licensing and obtaining an API Key.
Accessing the Feed
Each client has a unique hostname associated with their AppArmor Dashboard account. The Incident Reporting Feed is accessed by appending the path “/IncidentReporting/Feed/” and the “[KEY]” parameter to the Dashboard url. For instance, if your AppArmor Dashboard URL is clientname.apparmor.com, and your API key is “abcd-1234-abcd-1234” then the API can be accessed at the following URL:
| Code Block |
|---|
https://clientname.apparmor.com/IncidentReporting/Feed/?[KEY]=abcd-1234-abcd-1234 |
Data Format
By default, the feed will show a table of the reports, but you can adjust the format of the feed by specifying the [format] attribute to one of "CSV", "XML", "JSON". Here's an example:
| Code Block |
|---|
https://clientname.apparmor.com/IncidentReporting/Feed/?[KEY]=abcd-1234-abcd-1234&[format]=XML |
Date Range
Similarly, you can adjust the number of days that is shown in the feed by adding the [days] parameter. Here's an example limiting to 1 day:
| Code Block |
|---|
https://clientname.apparmor.com/IncidentReporting/Feed/?[KEY]=abcd-1234-abcd-1234&[format]=XML&[days]=1 |
Sort Order
The sort order defaults to descending by date, but can be reversed by adding [sortorder]=ASC like this:
| Code Block |
|---|
https://clientname.apparmor.com/IncidentReporting/Feed/?[KEY]=abcd-1234-abcd-1234&[format]=XML&[days]=1&[sortorder]=ASC |
Custom Filters
You can also add any custom filters on the data you'd like by specifying the field name in the url with the format "&fieldname=value". Here's an example using "User Email":
...