UPupguard
risks

Get portfolio risk profile overview

Returns an overview of all risks affecting vendors that match the specified filter criteria or all vendors. This endpoint provides a consolidated view of cybersecurity risks.

The response includes the total number of vendors matching your filter and a list of all risks found, with details about how many vendors are affected by each risk.

Results are paginated. Use the page_size parameter to control how many results are returned per page (default: 100, max: 2000). Use the next_page_token from the response to retrieve subsequent pages.

Required API key permissions: VendorRisk (select when creating API key in Account Settings)

get/risks/vendors/all

Request

Query parameters

vendor_labelsstring[]

Filter on vendor labels using the label’s name. By default, any matching vendor will be returned. Use vendor_label_ids_match_all to require all labels to be present. If the label does not exist, 422 will be returned.

vendor_label_ids_match_allboolean

If true, will only return vendors that match ALL of the provided label IDs. If false or omitted, vendors matching ANY of the provided labels will be returned.

include_unlabeledboolean

If true, will include vendors that have no labels applied when vendor_label_ids is provided.

min_scoreinteger

Filter vendors to those with a score greater than or equal to this value. Valid range: 0-950.

max_scoreinteger

Filter vendors to those with a score less than or equal to this value. Valid range: 0-950.

name_prefixstring

Filter vendors whose name starts with the given prefix (case-insensitive).

vendor_idsinteger[]

Filter to only return vendors with the specified vendor IDs.

vendor_label_ids_do_not_matchboolean

If true, will only return vendors that DO NOT match ANY of the provided label IDs. This is mutually exclusive with vendor_label_ids_match_all.

vendor_tiersinteger[]

Filter watched vendors to those in the specified tiers. Valid values: 1-5.

portfoliosstring[]

Filter by portfolio IDs. Only vendors in these portfolios will be returned. If the portofilo does not exist, 422 will be returned.

assessed_vendors_onlyboolean

If true, will return only vendors with a published assessment.

questionnaire_type_idsinteger[]

Filter by questionnaire type IDs. Only vendors with these questionnaire types will be returned. Available questionnaire types can be found at /api/public/vendor/questionnaire_types.

vendor_date_added_startstring date-time

Start of date added range filter (RFC3339 format). Filters vendors added on or after this date.

vendor_date_added_endstring date-time

End of date added range filter (RFC3339 format). Filters vendors added on or before this date.

vendor_date_added_beforeboolean

If true, filter to vendors added before vendor_date_added_end.

vendor_date_added_betweenboolean

If true, filter to vendors added between start and end dates.

page_sizeinteger

The number of results to return per page. Valid values range from 10 to 2000. Defaults to 100 if not specified.

page_tokenstring

Token to retrieve a specific page of results. Omit to retrieve the first page. Use the next_page_token from the previous response to get the next page.

Response

VendorRiskOverviewV1Response is the response for the vendor risk overview endpoint.

next_page_tokenstring

Token to retrieve the next page of results. Omitted if there are no more results.

Example response

{
  "next_page_token": "eyJ2IjoxMDAsImUiOjE3MDAwMDAwMDAsImgiOiJhYmMxMjMifQ==",
  "risks": [
    {
      "adjusted_severity": "high",
      "category_title": "Email Security",
      "date_first_detected": "2024-01-15T10:30:00Z",
      "description": "No SPF record is configured for this domain",
      "fact_category": "email_security",
      "id": "dns_spf_not_configured",
      "known_exploited_vulnerability": true,
      "num_failed_vendors": 5,
      "risk_type": "cloudscan",
      "severity": "medium",
      "title": "SPF record not configured"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.