...
Please note that the API must be used by a qualified developer. AppArmor does not provide software development training, nor does our team know the details of implementing the API in all programming environments. Our support team is able to provide general support and troubleshooting help for the API, but they will be unable to assist with the unique implementation details of your systems.
API Key
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.
...
Similarly, you can adjust the number of days that is shown in the feed by adding the [days] parameter. Ommitting the [days] parameter will default to “3” days. 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 |
| Info |
|---|
The default value if no [days] parameter was originally 30 days. This was changed to 1 day on November 3rd 2020. If you require more than 1 day, please specify the [days] attribute. |
Minute Range
Alternatively, if you need to poll frequently, you use the [minutes] parameter.
Here's an example limiting to 15 minutes:
| Code Block |
|---|
https://clientname.apparmor.com/IncidentReporting/Feed/?[KEY]=abcd-1234-abcd-1234&[format]=XML&[minutes]=15 |
| Info |
|---|
If present [minutes], it takes precedence over the [days] parameter. |
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 |
Max Rows
If you need to specify the number of rows, use the [maxrows] parameter. Defaults to 100.
| Code Block |
|---|
https://clientname.apparmor.com/IncidentReporting/Feed/?[KEY]=abcd-1234-abcd-1234&[format]=XML&[days]=1&[maxrows]=1000 |
Showing ID Columns
By default, the ID and BadgeID columns are not shown in the feed. To enable them add “&[ID]=true” or “&[BadgeID]=true to the URL. Here is an example:
| Code Block |
|---|
https://clientname.apparmor.com/IncidentReporting/Feed/?[KEY]=abcd-1234-abcd-1234&[ID]=true&[BadgeID]=true |
Badge Override Column
A column indicating whether the badge has been manually overridden can be showing by adding “&[Override]=true” to the feed URL. Here is an example:
| Code Block |
|---|
https://clientname.apparmor.com/IncidentReporting/Feed/?[KEY]=abcd-1234-abcd-1234&[Override]=true |
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":
...