GET: Portfolio Threats [v1] – Bitsight Knowledge Base

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

See threats (such as vulnerabilities) detected in your portfolio.

Version 2 is now available.

Parameters

See query parameters for details on the following parameters:

fields
format (Default: ↻ json)
limit (Default: ↻ 10)
offset (Default: ↻ 0)
q

Parameter Values

company_guid

[Query] Filter by company.

[String] Company unique identifier [entity_guid]. See GET: Portfolio Details. The impacts_group parameter must be set to true to use this parameter.

category_slug

[Query] Filter by category.

[String] Category slug name.

currently_exposed_count_lte

[Query] Set a maximum number of exposed entities.

[Integer]

currently_exposed_count_gte

[Query] Set a minimum number of exposed entities.

[Integer]

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

first_seen_date_gte

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

first_seen_date_lte

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

last_seen_date_gte

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

last_seen_date_lte

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

expand

[Query] Include the number of questionnaires sent to each threat.

[String] questionnaires_sent

folder

[Query] Filter by folder.

[String] Folder unique identifier [folder_guid]. See GET: Folder Details.

impacts_group

[Query] Filter by impact.

[Boolean]

true = Include threats that are affecting the entities.
false = Include threats that are not affecting the entities.
null = Include all threats.

previously_exposed_count_gte

[Query] Set a minimum number of previously exposed entities.

[Integer]

previously_exposed_count_lte

[Query] Set a maximum number of previously exposed entities.

[Integer]

severity_level

[Query] Filter by vulnerability severity.

[String] Bitsight severity slug name.

severity_gte

[Query] Filter by severity.

[Integer]

severity_lte

[Query] Filter by severity.

[Integer]

sort

[Query] Sort the response objects in alphabetical order.

[String]

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

threat_guid

[Query] Filter by threat.

[String] Threat unique identifier [threat_guid].

tier

[Query] Filter by tier.

[String] Tier unique identifier [tier_guid]. See GET: Tiers.

Example Request

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

Example Response

{
  "links": {
    "previous": "string",
    "next": "string"
  },
  "count": 0,
  "results": [
    {
      "guid": "string",
      "name": "string",
      "first_seen_date": "string",
      "last_seen_date": "string",
      "severity": {
        "level": "string",
        "details": "string"
      },
      "category": {
        "name": "string",
        "slug": "string"
      },
      "support_started_date": "string",
      "currently_exposed_count": 0,
      "previously_exposed_count": 0,
      "exposure_trend": 0,
      "questionnaires_sent": 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`]		The threat unique identifier.
		name String		The CVE ID or vulnerability name.
		first_seen_date String [`YYYY-MM-DD`]		The date when this threat was first seen.
		last_seen_date String [`YYYY-MM-DD`]		The date when this threat was last seen.
		severity Object		The vulnerability severity.
			level String	The severity level.
			details String	The CVSS score.
		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.
		currently_exposed_count Integer		The number of companies that have been observed to have evidence of exposure.
		previously_exposed_count Integer		The number of companies that have evidence of active mitigation.
		exposure_trend Integer		The portfolio changes over the last 14 days.
		questionnaires_sent Integer		The number of questionnaires that have been sent.

Status Codes

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

October 17, 2024: Version 2 is now available.
March 1, 2024: Published.

Parameters

Example Request

Example Response

Response Attributes

Status Codes

Related articles