CEcensys
Supplier Risk

List risk instances

Changed on

Retrieve individual risk instances (one risk type observed on one asset belonging to one supplier) across your supply chain. By default the entire supply chain is searched. Provide supplier_ids to narrow your search.<br><br>For risk-type aggregations, use the list risks endpoint.

get/v1/supplychains/{supply_chain_id}/risk-instances

Request

  • Base URL
    https://api.platform.censys.io
  • URL
    https://api.platform.censys.io/v1/supplychains/{supply_chain_id}/risk-instances
  • Auth
    HTTP bearer

Path parameters

supply_chain_idstring required

The ID of a Censys supply chain, or the literal 'default' for your organization's primary supply chain. Obtain the supply chain ID using the list supply chains endpoint or from the Supplier Risk URL in the web console.

Example:11111111-2222-3333-4444-555555555555

Query parameters

organization_idstring uuid required

The ID of a Censys organization to associate the request with. See the Getting Started docs for more information.

Example:11111111-2222-3333-4444-555555555555
supplier_idsstring[] nullable

Narrow the search to one or more Censys suppliers in the supply chain. For multiple values, include comma-separated values. When omitted, the entire supply chain is searched.

[
  "11111111-2222-3333-4444-555555555555"
]
querystring

A CenQL query. When provided, must reference at least one risk field, for example risk.severity. Combined with severity/risk_type/resource_type/rapid_response, if set, using AND.

severity'UNSPECIFIED' | 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL'

Filter to a single risk severity. When omitted, every severity is included.

risk_type'misconfigs' | 'vulns' | 'exposures' | 'threats'

Filter to a single risk category. When omitted, misconfigurations, vulnerabilities, exposures, and threats are all included.

resource_type'hosts' | 'web'

Filter to risks observed on a single asset resource type. When omitted, hosts and web are both included.

rapid_responseboolean

When true, filter to risk instances flagged for rapid response. When omitted or false, no filter is applied on this field.

order_by'last_detected_at_asc' | 'last_detected_at_desc' | 'created_at_asc' | 'created_at_desc'

Sort order. When omitted, results are returned in the backend's default order.

page_sizeinteger

Maximum number of risk instances to return per page.

page_tokenstring

Pagination token from a previous response to retrieve the next page of results.

Headers

X-Organization-IDstring uuid

The ID of a Censys organization to associate the request with. See the Getting Started docs for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter.

Example:11111111-2222-3333-4444-555555555555

Response

Risk instances returned successfully

Changes