API Reference

List risk instances

get
https://api.platform.censys.io/v1/supplychains//risk-instances

Returns individual risk instances (one risk type observed on one asset belonging to one supplier) across a supply chain. By default the entire supply chain is searched; provide supplier_ids to narrow the search to specific suppliers. For risk-type level aggregates, see ListRisks.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The UID for the supply chain or the literal 'default'. Obtain the supply chain ID using the list supply chains endpoint or via the supply chain intelligence URL when using the web console. If set to 'default', will return risk instances for the organization's primary supply chain.

Query Params
uuid
required

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

supplier_ids
array of uuids | null

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.

supplier_ids
string

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.

string
enum

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

Allowed:
string
enum

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

Allowed:
string
enum

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

Allowed:
boolean
Defaults to false

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

string
enum

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

Allowed:
int32
1 to 1000
Defaults to 100

Maximum number of risk instances to return per page.

string

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

Headers
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.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 4 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 4 hours ago

Did this page help you?