ips

Get a list of ips

Returns a list of ips for your account.

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

get/ips

Request

Query parameters

labelsstring[]

Filter result by the provided labels

asset_portfolio_namesstring[]

Only return IPs in any of these domain portfolios. Get portfolio names from /asset_portfolio/list. Portfolio names are case-sensitive. An IP is in the portfolios of the enabled domains that resolve to it. An IP that no domain resolves to is in no portfolio, not even the default portfolio. Returns 422 if your account does not have domain portfolios or a portfolio does not exist.

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'ip' | 'owner' | 'country' | 'asn' | 'as_name' | 'automated_score'

The value to sort the IPs by

If not specified will default to ip and set sort_desc to true

sort_descboolean

Whether or not to sort the results in descending order

Response

A list of ips

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 ips found.

Changes

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