UPupguard
risks

Get a list of available risks in the platform

Changed on

Returns a list of available risks in the UpGuard platform with detailed info.

Some risks in the platform are generic risks like "exposed_service:*". The values of some of the fields for these risks depends on the details of the risk, e.g. which particular service is exposed. As such these fields are omitted from the response.

To get the full details for a specific risk, e.g. "exposed_service:FTP", use the risk details endpoint which will return the full information for the particular service.

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

get/available_risks/v2

Request

Query parameters

categorystring

Filter by risk category

severity'info' | 'low' | 'medium' | 'high' | 'critical'

Filter by risk severity

Response

Available risks

categorystring

The category of the risk. This field will be omitted for generic risks

descriptionstring

Description or context surrounding the risk. This field will be omitted for generic risks

findingstring

Description of the finding. This field will be omitted for generic risks

genericboolean

Flag indicating whether the risks is a generic risk, i.e. a risk where severity, category, finding etc. depend on other parameters

groupstring

The risk group

idstring

The ID of the risk

remediationstring

Remediation recommendation. This field will be omitted for generic risks

riskstring

The risk title

riskDetailsstring

Detailed description of the risk. This field will be omitted for generic risks

riskSubtypestring

The subtype of the risk, e.g. the subtype of the verified_vuln:CVE-2021-34473 is CVE-2021-34473. This field will be empty if the risk has no subtype, e.g. for wp_version_exposed, or for generic risks like verified_vuln:* where the subtype is only determined when the full risk is specified.

riskTypestring

The type of the risk, e.g. the type of the verified_vuln:CVE-2021-34473 is verified_vuln

severity'pass' | 'info' | 'low' | 'medium' | 'high' | 'critical'

The severity of the risk. This field will be omitted for generic risks

Example response

[
  {
    "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",
    "group": "domain",
    "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": "Domain at risk of being hijacked",
    "riskDetails": "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",
    "severity": "critical"
  }
]

Changes

  • d044bf6dc61eRevision changes
    • info

      added the new optional query request parameter category

    • info

      added the new optional query request parameter severity