Skip to main content
Security Performance Management
Continuous Monitoring
Vendor Risk Management
Cyber Insurance
National Cybersecurity

GET: Cataloged Threats

Ingrid

⇤ Threats

https://api.bitsighttech.com/ratings/v1/threats/catalog

Get cataloged threats.

Parameters

See query parameters for details on the following parameters:

  • fields
  • format (Default: ↻ json)
  • limit (Default: ↻ 10)
  • offset (Default: ↻ 0)
  • q
Parameter Values 
category

[Query]

 [String]
Date Filters [String] The date [YYYY-MM-DD].
  
support_started_date_gt

[Query] Filter threats that were supported after a particular date.

 
support_started_date_gte

[Query] Filter threats that were supported on and after a particular date.

 
support_started_date_lt

[Query] Filter threats that were supported before a particular date.

 
support_started_date_lte

[Query] Filter threats that were supported on and before a particular date.

 
guid

[Query]

 [String] 
name

[Query] Filter by name.

 [String] 
severity_level

[Query]

 [String] 
sort

[Query] Sort the response objects in ascending, alphabetical order for a particular field.

[String]

  • ↻ name (default)
  • To sort in descending order, place a minus sign (-) immediately before the field name.

Example Request

curl https://api.bitsighttech.com/ratings/v1/threats/catalog -u api_token:

Example Response

{
  "links": {
    "previous": "string",
    "next": "string"
  },
  "count": 0,
  "results": [
    {
      "guid": "string",
      "name": "string",
      "display_name": "string",
      "description": "string",
      "remediation_tip": "string",
      "details": {
        "cvss": "string",
        "confidence": "string",
        "severity": "string",
        "status": "string"
      },
      "category": {
        "name": "string",
        "slug": "string"
      },
      "support_started_date": "string"
    }
  ]
}

Response Attributes

Field Description 
links
Object		 Navigation for multiple pages of results. See pagination.
  
previous
String		 The URL for navigating to the previous page of results. 
next
String		 The URL for navigating to the next page of results. 
count
Integer		 The number of threats. 
results
Array		 Threats and their details.
  Object A threat.
  
guid
String [threat_guid]		 Threat unique identifier. 
name
String		 The CVE ID or name of this vulnerability. 
display_name
String		 The vulnerability name if it’s a prominent vulnerability. 
description
String		 Details about the vulnerability. 
remediation_tip
String		 Remediation instructions. 
details
Object		 Vulnerability details.
  
cvss
String		 The CVSS score. 
confidence
String		   
severity
String		   
status
String		   
category
Object		  
  
name
String		   
slug
String		   
support_started_date
String [YYYY-MM-DD]		 The date when this threat was first supported in the Bitsight platform.

Status Codes

Code Description
200 – Success Everything worked as expected.
422 – Validation Error There was a validation error.
March 1, 2024: Published.

Related articles

Feedback

0 comments

Please sign in to leave a comment.