risks
Get a list of active risks for a vendor
Returns a list of risks that have been detected for a particular vendor.
Required API key permissions: VendorRisk (select when creating API key in Account Settings)
get/risks/vendors
Request
- Base URLhttps://cyber-risk.upguard.com/api/public
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
primary_hostnamestring required
The primary hostname of the vendor to return risks for
min_severity'info' | 'low' | 'medium' | 'high' | 'critical'
Minimum severity for the risks
include_metaboolean
Include metadata for risks, include_meta and 'exclude_hostnames' cannot both be true
exclude_hostnamesboolean
Exclude hostnames for risks, include_meta and 'exclude_hostnames' cannot both be true
include_sourcesboolean
Include sources for risks, e.g. the hostname and/or IP addresses the risk was detected on, including ports when available
Response
A list of detected risks
Example response
{
"risks": [
{
"category": "dns",
"description": "Domains must be renewed within specified intervals to maintain ownership of the name. The minimum interval is 1 year and the maximum interval is 10 years. If a domain is not renewed within the appropriate interval, the domain name becomes “expired.” There is a 30 day grace period where the domain owner can still renew the expired domain name. After that, the domain can be purchased by a third party",
"finding": "Domain expired",
"firstDetected": "\"2019-10-12T07:20:50.52Z\"",
"hostnameCount": 2,
"hostnameMeta": {
"example.com": "'SMTP': [listening on port 25]"
},
"hostnames": [
"example.com",
"subdomain.example.com"
],
"id": "domain_expired",
"remediation": "The domain should be renewed as soon as possible with the registrar. Domains can be configured with auto-renewal to ensure that they are renewed before the expiration date",
"risk": "This domain is expired. An expired domain is no longer functional. Any services relying on the expired domain will become unavailable. In addition to the loss of functionality, expired domains can be snapped up quickly by third parties and used to drive traffic to malicious and fraudulent websites",
"riskSubtype": "CVE-2021-34473",
"riskType": "verified_vuln",
"risk_waivers": [
{
"active_at": "\"2019-10-12T07:20:50.52Z\"",
"approved_by": "\"john@example.com\"",
"created_by": "\"john@example.com\"",
"expires_at": "\"2019-10-12T07:20:50.52Z\"",
"hostnames": [
"example.com",
"subdomain.example.com"
],
"justification": "\"Loren Ipsum\""
}
],
"severity": "high",
"sources": [
"192.168.1.1",
"subdomain.example.com",
"example.com:443"
]
}
]
}Changes
No recorded changes to this operation across all 2 revisions of this API.