GET: Threat Evidence [v2]

Ingrid

https://api.bitsighttech.com/ratings/v2/threats/threat_guid/companies/entity_guid/evidence

Get a company’s threat (such as vulnerabilities) evidence details.

Parameters
Example Request
Example Response
Response Attributes

Parameters

See query parameters for details on the following parameters:

* Required.

format
limit (Default: ↻ 10)
offset (Default: ↻ 0)
q
sort (Default: ↻ identifier)

company_guid

* Required.

[Path] Identify the company to query.

Value: [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

evidence_certainty

[Query] Filter by evidence certainty.

Value: [String] See evidence certainty.

exposure_detection

[Query] Filter by exposure detection status.

Value: [String] See exposure detection.

force_masked

[Query] Mask the IP address.

If the entity has opted-out of Manage IP Visibility, the IP is masked regardless of this setting .

Value: [Boolean] true = Mask the IP address.

detection_type

[Query]

Value: [String]

early_detection = The data was collected from manually loaded sources.
standard = The data was collected through standard methods.

[Date] first_seen_date_gte

[Query] Filter threats first seen on and after a specific date.

Value: [String] YYYY-MM-DD

[Date] first_seen_date_lte

[Query] Filter threats first seen on and before a specific date.

Value: [String] YYYY-MM-DD

[Date] last_seen_date_gte

[Query] Filter threats last seen on and after a specific date.

Value: [String] YYYY-MM-DD

[Date] last_seen_date_lte

[Query] Filter threats last seen on and before a specific date.

Value: [String] YYYY-MM-DD

threat_guid

* Required.

[Path] Identify the threat to query.

Value: [String] Threat unique identifier [threat_guid]. See GET: Portfolio Threats.

Example Request

curl https://api.bitsighttech.com/ratings/v2/threats/threat_guid/companies/entity_guid/evidence -u api_token:

Example Response

{
  "links": {
    "previous": null,
    "next": null
  },
  "count": 2,
  "results": [
    {
      "identifier": "Black Hills Technologies @ blackhills.com",
      "certainty": "POSSIBLE",
      "exposure_detection": "EXPOSED",
      "detection_type": "early_detection",
      "first_seen_date": "2024-05-02",
      "last_seen_date": "2024-05-13",
      "evidence_tag": {
        "name": "Software from vulnerable provider in use",
        "slug": "SOFTWARE_FROM_VULNERABLE_PROVIDER_IN_USE"
      }
    },
    […]
  ]
}

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 on this company.
results Array				Threats and their details.
	Object			A threat.
		identifier String		Identifies the asset that the threat is associated with.
		certainty String		A measure of how certain we are about the company’s threat detection.
		exposure_detection String		The company's exposure detection status from threats.
		detection_type String		How the data was collected. `early_detection` = The data was collected from manually loaded sources. `standard` = The data was collected through standard methods.
		first_seen_date String [`YYYY-MM-DD`]		The date when the threat was first seen.
		last_seen_date String [`YYYY-MM-DD`]		The date when the threat was last seen.
		evidence_tag Object		The type of evidence seen for this record. `LONG_TIME_SINCE_LAST_DETECTION` `MITIGATION_APPLIED` `RELATIONSHIP_WITH_VULNERABLE_PROVIDER_INDICATED` `VULNERABLE_SOFTWARE_OR_CONFIGURATION_IN_USE` `VULNERABLE_SOFTWARE_VERSION_IN_USE`
			name String	The name of the evidence.
			slug String	The slug name of the evidence.

October 18, 2024: Published.