UPupguard
vendors

List monitored vendors

If the include_ad_hoc_reports parameter is set to true then vendors with ad hoc reports available will also be returned.

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

get/vendors

Request

Query parameters

include_ad_hoc_reportsboolean

Include vendors with an existing ad hoc report in the results.

page_tokenstring

The token of the page to be returned. Will return the first page if left blank.

page_sizeinteger

The number of results to return per page. Valid values range from 10 to 2000. Defaults to 1000 if unset.

labelsstring[]

Filter result by the provided labels

include_risksboolean

Include risks

Response

A list of vendors

next_page_tokenstring

The token to be used to retrieve the next page of results. Will not be returned if there are no more results.

total_resultsinteger

The total number of vendors found.

Example response

{
  "vendors": [
    {
      "risks": [
        {
          "category": "vulnerability_management",
          "description": "Remote code execution exploit chain consisting of 3 vulnerabilities in Microsoft Exchange Server: CVE-2021-34473, CVE-2021-34523 and CVE-2021-31207",
          "finding": "Vulnerable to CVE-2021-34473 (ProxyShell)",
          "id": "verified_vuln:CVE-2021-34473",
          "riskSubtype": "CVE-2021-34473",
          "riskType": "verified_vuln",
          "severity": "high"
        }
      ]
    }
  ]
}

Changes

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