Page tree

Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Get Notification Alerts API retrieves notification alerts for an account. 

Notification alerts are generated when certain actions take place, such as updates to a ticket.

Your account must be configured to receive notification alerts in order to use this API. Additionally, this API only retrieves unread alerts. 

You can use this API to find the alertID (id). You will need this ID for other notification-related APIs. 


Sample request

GET https://api.armor.com/notifications/alerts?page=1&limit=25

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/notifications/alerts?page={page}&limit={limit}GET

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
pageNumber of pages requestedIntegerRequired1
limitNumber of records in pageIntegerRequired25

To use multiple, optional parameters in one request, you must use the ampersand symbol ( & ) to connect each parameter together.


Sample return

StatusResponse
200
[
  {  
  "id":"1",
  "Name":"Virtual machine 'sp Windows...",
  "CreatedDate":"2015-12-29 01:00:03.353",
  "Read":"0",
  "Notified":"0",
  "Type":"7",
  "EntityId":"10371",
  "UserId":"5658",
  "AccountId":"3861",
  "Description":"Virtual machine...",
 "EntityUuId":"1054711E-2D29-4B07-9F4E-EAF7B7233AB7"
}
]
400
{
 "Message": "The request is invalid."
}