Loading...

Knowledge Base
Home 
 
/
 Get Pending Threat Notifications Using the API
Categories: SiteLock API

Get Pending Threat Notifications Using the API

When you want to retrieve pending threat notifications using the API. This article explains threat notification details, affected domain information, customer mapping, notification IDs, and threat notification response structure.

Get Threat Notifications

 

Description

Gets a list of pending threat notifications.

Parameters

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredYour Live Account Reseller Id
api-keyStringRequiredAn alphanumeric code that can be used to authenticate your API calls
reseller-idIntegerOptionalReseller ID of the Reseller for whom threat notifications are to be retrieved. By default, threat notifications for the current user will be retrieved.

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/sitelock/threat/pending.json?auth-userid=0&api-key=key

Response

Returns a hash map containing the below details:

  • Customer ID of the Customer for whom threat notifications are pending (customerId)

    • Domain name for which threat notifications are pending (domainName)

      • Creation time for the threat notification (creationTime)

      • Notification ID associated with the threat notification (notificationId)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

The response structure will be:

{ "account": [ { "customerId":0, "website": [ { "domainName":"domain1.com", "notification": [ { "creationTime":1398758909871, "notificationId":2 } ] }, { "domainName":"domain2.com", "notification": [ { "creationTime":1398759150807, "notificationId":3 } ] } ] }, { "customerId":1, "website": [ { "domainName":"domain3.com", "notification": [ { "creationTime":1398759334814, "notificationId":4 } ] } ] } ] }