Skip to main content
GET
List domains

Authorizations

X-API-Key
string
header
required

Query Parameters

domains
string<hostname>[]

A list of domains to fetch. If this parameter is present, only domains whose name matches an item in this list are returned.

limit
integer<int32>

The maximum number of domains included in the response. If not specified, defaults to 10.

Required range: x <= 5000
offset
integer<int32>

Offset into the list of domains to return. If not specified, defaults to 0.

Response

Successfully found the domain

domains
object[]
required

A list of domains

total
integer<int32>
required

The total number of domains that are accessible with the given API key that match the list of domains in the 'domains' parameter. If there is no 'domains' parameter, this field is the total number of domains that are accessible with with this API key. A domain is accessible with a given API key if it is associated with that API key, or if it is not associated with any API key.