GET: Tier Threshold Alerts – Bitsight Knowledge Base

https://api.bitsighttech.com/ratings/v1/tiers/thresholds

Example Request

curl https://api.bitsighttech.com/ratings/v1/tiers/thresholds -u api_token:

Example Response

[
  {
    "guid":"5ccb70d1-999f-45d0-91c7-48a635debbb9",
    "folder":"86b6ffa2-ca5a-4585-9fbf-b22f9be8e99b",
    "critical_threshold":null,
    "warn_threshold":null,
    "increase_threshold":null,
    "creator":null,
    "is_folder_shared":false,
    "is_enabled":false,
    "type":"RATING_THRESHOLD",
    "created_date":"2020-04-23T14:36:14.752770Z",
    "creator_name":null,
    "folder_name":"Tier 1",
    "is_editable":true,
    "is_global":true,
    "risk_category":null,
    "nist_category":null,
    "info_category":null,
    "public_disclosure_category":null,
    "tier_rating_thresholds":[
      {
        "name":"escalate",
        "rating":{
          "lt":500,
          "gte":null
        }
      }
    ]
  }
]

Response Attributes

Field			Description
guid String [`alert_guid`]			The unique identifier of this alert.
folder String [`tier_guid`]			The unique identifier of this tier.
critical_threshold String			The risk vector grade or rating threshold for critical changes.
warn_threshold String			The risk vector grade or rating threshold for warn changes.
increase_threshold String			The risk vector grade or rating threshold for increase changes.
creator Null			For internal Bitsight use.
is_folder_shared Boolean			For internal Bitsight use.
is_enabled Boolean			Indicates if the alert is enabled. `true` = Enabled `false` = Disabled
type String			The alert category.
created_date String [`YYYY-MM-DDTHH:MM:SSZ`]			The date and time when the thresholds for this alert were defined.
creator_name Null			For internal Bitsight use.
folder_name String			The name of this tier.
is_editable Boolean			For internal Bitsight use.
is_global Boolean			Indicates whether this tier is a global or group tier. `true` = Global tiers `false` = Group tiers
risk_category String			If the alert category is Risk Vector Grades (`"type":"RISK_CATEGORY"`), this is the associated risk type.
nist_category String			If the alert category is NIST CSF Grades (`"type":"NIST_CATEGORY"`), this is the associated NIST function category.
info_category String			If the alert category is Informational Risk Vectors (`"type":"INFORMATIONAL"`), this is the associated risk type.
public_disclosure_category String			If the alert category is Public Disclosures (`"type":"PUBLIC_DISCLOSURE"`), this is the associated risk type.
tier_rating_thresholds Array			Threshold details of the tier.
	name String		The action plan for this tier.
	rating Object		Threshold details if the threshold is based on ratings.
		lt Integer	The rating value for the minimum threshold.
		gte Integer	The rating value for the maximum threshold.

December 2, 2020: Published.

Example Request

Example Response

Response Attributes

Related articles