Scout Alert& Incident API
DigitalStakeout Scout Alert & Incident API
See the following developer documentation to consume DigitalStakeout Scout alerts and incidents by REST API.
https://documenter.getpostman.com/view/2424221/UVsTp2BR#intro
API Keys
API keys are required for performing requests for the DigitalStakeout Scout Alert API. From this page you can generate a new key or retrieve a key which has already been generated. After navigating to My Account, Go to the Integrations tab, and generate a Token, click SAVE.
API Access
API Keys are are "PINNED" to a user. API Keys generated by a user will have access to the same data the user can access in the Portal.
Rate Limits
Rest API requests are subject to rate limits within a 15 minute period, which will be done per API key per API endpoint. If a limit is exceeded, we will return a HTTP 429 error code (Too Many Requests). This API should not be queried more than a rate of 1 per second. In most cases, polling every 1 every 60 seconds is adequate.
Pseudo Exporting
Due to copyright restrictions from data providers, it is not intended for this API to become an export mechanism for all the results in your DigitalStakeout Scout instance. If your Alert volume is greater than 5% than your aggregate collection volume, data tagging to allow results to be consumed by this API will be rate limited.
Response Schema
This is the schema of the alert response.
Response Example
This is an example of an alert response.
https://portal.digitalstakeout.com/api/v2/scout/alerts/response.json
Errors
DigitalStakeout's API use the following error codes:
|
Code
|
Meaning
|
|
400
|
Bad Request – Your request is bad.
|
|
401
|
Unauthorized – Your API key is wrong.
|
|
404
|
Not Found – The specified url could not be found.
|
|
405
|
Method Not Allowed – You tried to access our api with an invalid method.
|
|
406
|
Not Acceptable – You requested a format that isn’t json.
|
|
429
|
Too Many Requests – You’re sending too many requests! Slow down.
|
|
500
|
Internal Server Error – We had a problem with our server. Try again later.
|
|
503
|
Service Unavailable – We’re temporarily offline for maintenance. Please try again later.
|
Need help with this?
The DigitalStakeout team is happy to help! To request assistance, open a ticket .
Related Articles
Create Basic Email Alert Rule
DigitalStakeout provides the ability to create basic email alerts for notification of valuable events collected within a monitor, collection or folder. Basic email alerts are configured within the DigitalStakeout product through the homepage. ...
Video: Create an Email Alert Rule
Basic email alerts will automatically notify you when important events happen in your Scout implementation. Scout email alerts are configured by navigating to the Workflow tab. We call this an Email Alert rule. The following video will demonstrate ...
Organizing Scout Monitors and Results
Organizing Scout Monitors and Results DigitalStakeout provides the ability to organize monitors and content in folders. This provides a “file system” for monitors and collected data. This is a typical parent/child folder relationship; if a folder is ...
Video: Scout NOT Facet Filter
The following video will demonstrate how to create a NOT facet filter.
Dashboard Monitor Summary
DigitalStakeout's Monitor Summary Dashboard is an information management tool that allows you to visually track your monitors' activity. Threat Severity by Location: This heat map displays locations of results that have geo tags. Monitor Summary: ...