vendors
List vendor domains
Returns a list of domains for a vendor.
Required API key permissions: VendorRisk (select when creating API key in Account Settings)
get/vendor/domains
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
vendor_primary_hostnamestring required
The primary hostname of the vendor to show domains for.
activeboolean
Retrieve active domains
inactiveboolean
Retrieve inactive domains
labelsstring[]
Filter result by the provided labels
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_by'domain' | 'active' | 'automated_score' | 'scanned_at'
The value to sort the domains by
If not specified will default to domain and set sort_desc to true
sort_descboolean
Whether or not to sort the results in descending order
Response
A list of domains
Changes
No recorded changes to this operation across all 2 revisions of this API.