domains

Retrieve details for a domain

Returns the details for a domain. It will return 422 when requesting details of an inactive domain.

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

get/domain

Request

Base URL
https://cyber-risk.upguard.com/api/public
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/domain/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

hostnamestring required

The hostname for which to return the details, e.g. "upguard.com"

Response

Domain details

a_recordsstring[]

The list of A records associated with the domain. This field will be omitted if no A records were associated with the domain

automated_scoreinteger

The score for the domain. If the domain has not been scanned or no score is present this field will be omitted.

hostnamestring

The hostname of the domain

labelsstring[]

The labels associated with the domain. This field will be omitted if no labels are present.

scanned_atstring date-time

The time the domain was scanned in RFC3339 format

Example response

{
  "check_results": [
    {
      "riskSubtype": "CVE-2021-34473",
      "riskType": "verified_vuln"
    }
  ],
  "waived_check_results": [
    {
      "riskSubtype": "CVE-2021-34473",
      "riskType": "verified_vuln"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.