GET: Cataloged Threats – Bitsight Knowledge Base

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

Get cataloged threats. Threats include vulnerabilities and vulnerability groups.

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] Filter by category of threats

[String]

vulnerability
vulnerability_group

guid

[Query]

[String]

name

[Query] Filter by name.

[String]

severity_level

[Query] Filter by vulnerability severity.

[String] Bitsight severity slug name.

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.

Support Dates [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.

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",
        "severity": "string",
      },
      "category": {
        "name": "string",
        "slug": "string"
      },
      "support_started_date": "string"
      "epss": {
        "score": 97.5,
        "percentile": 100.0
      }
    }
  ]
}

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 or vulnerability group.
		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.
			severity String	The Bitsight severity.
		category Object		The threat category.
			name String	The category name.
			slug String	The category slug name.
		support_started_date String [`YYYY-MM-DD`]		The date when this threat was first supported in the Bitsight platform.
		epss Object		The Exploit Prediction Scoring System (EPSS), which estimates the likelihood that a software will be exploited. The higher the percentage the more likely it will be exploited.
		score Decimal		The EPSS score.
		percentile Decimal		The EPSS percentile.

Status Codes

Code	Description
`200` – Success	Everything worked as expected.
`422` – Validation Error	There was a validation error.

October 17, 2024: EPSS information.
March 1, 2024: Published.

Parameters

Example Request

Example Response

Response Attributes

Status Codes

Related articles