UPupguard
domains

Get a list of domains

Returns a list of domains for your account.

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

get/domains

Request

Query parameters

activeboolean

Retrieve active domains

inactiveboolean

Retrieve inactive domains

labelsstring[]

Filter result by the provided labels

asset_portfolio_namesstring[]

Only return domains in any of these domain portfolios. Get portfolio names from /asset_portfolio/list. Portfolio names are case-sensitive. A domain that is not in any portfolio is in the default portfolio. Returns 422 if your account does not have domain portfolios or a portfolio does not exist, and 403 if you do not have access to a portfolio.

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

next_page_tokenstring

The token to be used to retrieve the next page of results. Will not be returned if there are no more results.

total_resultsinteger

The total number of domains found.

Changes

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