breaches
Get a list of VIPs
Returns a list of VIPs for your account.
Required API key permissions: IdentityBreaches (select when creating API key in Account Settings)
get/vips
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
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_bystring[]
List of fields to sort VIPs by, with optional :asc or :desc suffix per field. Naming a field more than once returns 422. Allowed fields: name, domain, num_breaches, date_last_breach.
Response
A list of VIPs currently monitored for your account
Changes
No recorded changes to this operation across all 1 revision of this API.