UPupguard
bulk

List hostnames and their risks

Get the list of registered hostnames and their risks. You can use the omit_risks, omit_vendor, omit_score and omit_labels query parameter to turn off these information from the response and quickly get a list of registered hostnames.

This is an add-on endpoint not available to all accounts. Please contact support for information about bulk endpoints and how to upgrade your account.

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

get/bulk/hostnames

Request

Query parameters

page_tokenstring

The page_token from a previous request, use this to get the next page of results.

page_sizeinteger

The number of results to return per page.

sort_descboolean

Whether to sort the results in descending order.

omit_scan_infoboolean

Omit the scan information, i.e. risks, score and last scanned at.

omit_vendorboolean

Omit the vendor information for a hostname in the response.

omit_labelsboolean

Omit the labels for a hostname in the response.

exclude_activeboolean

Exclude active hostnames from the results.

exclude_inactiveboolean

Exclude inactive hostnames from the results.

labelsstring[]

Filter results to only hostnames that have all the provided labels.

Response

Returns the list of hostnames and their risks.

next_page_tokenstring

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

total_resultsinteger

The total number of hostnames found.

Example response

{
  "hostnames": [
    {
      "active": true,
      "automated_score": 800,
      "labels": [
        "network",
        "data"
      ],
      "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",
          "risk": "Vulnerabilities",
          "riskSubtype": "CVE-2021-34473",
          "riskType": "verified_vuln",
          "severity": "critical"
        }
      ],
      "vendor": {
        "id": 123456789,
        "name": "Example Industries",
        "primary_hostname": "example.com"
      }
    }
  ],
  "next_page_token": "123456789",
  "total_results": 1000
}

Changes

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