UPupguard
bulk

Get the details for a hostname

Get the details for a hostname. The provided hostname must be a fully qualified domain name or an IPv4 address.

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/{hostname}

Request

Path parameters

hostnamestring hostname required

The hostname to fetch details for. It must be a fully qualified domain name or an IPv4 address.

Query parameters

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.

Response

Returns the details of the hostname.

activeboolean

The active state of the hostname. These will be omitted if the omit_scan_info query parameter is true.

automated_scoreinteger

The automated score of the hostname. This will be omitted if the omit_scan_info query parameter is true.

hostnamestring hostname

The name of the hostname.

labelsstring[]

The list of labels associated with the hostname. This will be omitted if the omit_labels query parameter is true.

last_scanned_atstring date-time

The timestamp this hostname was last scanned at.

Example response

{
  "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"
  }
}

Changes

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