API

Get a policy domain

get
https://{hostname}/ip-protect/v1/policy-domains/

Returns summary information for the specified policy domain. Use the extended parameter to return information about the number of virtual IP addresses available to, and configured for, the domain.

Path Params
string
required

Unique name of the policy domain.

Query Params
boolean
required

Enables inclusion of ipsAllocated and ipsConfigured values in the query response. These parameters are omitted from the API response if you don't include extended or set its value to false.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Response

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago