- August 26, 2022: Alert category descriptions.
- December 2, 2020: Published.
Alerts can be set to help your organization better monitor the security performance of your portfolio.
Alert categories:
- Percent Change
- Rating Thresholds
- Risk Vector Grades
- NIST CSF Grades
- Informational Risk Vectors
- Public Disclosures
- Vulnerabilities and Infections
Percent Change
Be alerted when security ratings decrease or increase by a set percentage. This is useful for monitoring general fluctuations in a company or country's cyber security posture.
| Path | Purpose | Field | Value |
|---|---|---|---|
/v2/alerts |
GET: Alerts | alert_type |
PERCENT_CHANGE |
/v1/alerts/percent_change/alert_guid
|
GET: Percent Change Alert Details | alert_type |
PERCENT_CHANGE |
/v1/tiers/thresholds |
GET: Tier Threshold Alerts | type |
PERCENT_CHANGE |
Rating Thresholds
Be alerted when security ratings cross or reach a set threshold. This is useful for setting ratings requirements, highlights what to change or escalate, and helps start cybersecurity dialogues with your third parties.
| Path | Purpose | Field | Value |
|---|---|---|---|
/v2/alerts |
GET: Alerts | alert_type |
RATING_THRESHOLD |
/v1/alerts/rating_threshold/alert_guid
|
GET: Percent Change Alert Details | alert_type |
RATING_THRESHOLD |
/v1/tiers/thresholds |
GET: Tier Threshold Alerts | type |
RATING_THRESHOLD |
Risk Vector Grades
Be alerted when risk vector grades cross or reach a set threshold. This allows you to know which areas a company or group of companies are lagging or improving in their cybersecurity posture.
Not available for National Cybersecurity.
| Path | Purpose | Field | Value |
|---|---|---|---|
/v2/alerts |
GET: Alerts | alert_type |
RISK_CATEGORY |
/v1/alerts/risk_category/alert_guid
|
GET: Percent Change Alert Details | alert_type |
RISK_CATEGORY |
/v1/tiers/thresholds |
GET: Tier Threshold Alerts | type |
RISK_CATEGORY |
NIST CSF Grades
Be alerted when National Institute of Standards and Technology cybersecurity Framework (NIST CSF) grades cross or reach a set threshold. NIST CSF alerts allow you to be alerted when security postures change, and also allows you to measure alignment with the framework.
| Path | Purpose | Field | Value |
|---|---|---|---|
/v2/alerts |
GET: Alerts | alert_type |
NIST_CATEGORY |
/v1/alerts/nist_category/alert_guid
|
GET: Percent Change Alert Details | alert_type |
NIST_CATEGORY |
/v1/tiers/thresholds |
GET: Tier Threshold Alerts | type |
NIST_CATEGORY |
Informational Risk Vectors
Get alerts for informational risk vectors. Exposed Credentials is the first informational risk vector that can be set up with an alert.
| Path | Purpose | Field | Value |
|---|---|---|---|
/v2/alerts |
GET: Alerts | alert_type |
INFORMATIONAL |
/v1/alerts/informational/alert_guid
|
GET: Percent Change Alert Details | alert_type |
INFORMATIONAL |
/v1/tiers/thresholds |
GET: Tier Threshold Alerts | type |
INFORMATIONAL |
Public Disclosures
Be alerted of new Public Disclosure events, including Breach Security Incidents, General Security Incidents, Other Disclosures.
| Path | Purpose | Field | Value |
|---|---|---|---|
/v2/alerts |
GET: Alerts | alert_type |
PUBLIC_DISCLOSURE |
/v1/alerts/public_disclosure/alert_guid
|
GET: Percent Change Alert Details | alert_type |
PUBLIC_DISCLOSURE |
/v1/tiers/thresholds |
GET: Tier Threshold Alerts | type |
PUBLIC_DISCLOSURE |
Vulnerabilities and Infections
Be alerted to infections and confirmed vulnerabilities that affect companies in your portfolio. You'll get alerted when a new finding is observed that currently affects your portfolio or is observed for the first time.
| Path | Purpose | Field | Value |
|---|---|---|---|
/v2/alerts |
GET: Alerts | alert_type |
VULNERABILITY |
/v1/alerts/vulnerability/alert_guid
|
GET: Percent Change Alert Details | alert_type |
VULNERABILITY |
/v1/alerts/vulnerability/vulnerability_alert_guid
|
GET: Vulnerability Alert Details | alert_type |
VULNERABILITY |
/v1/tiers/thresholds |
GET: Tier Threshold Alerts | type |
VULNERABILITY |