Skip to main content
POST
Start a subdomain search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Start a search for one domain's subdomains.

domain
string
required

The domain to search, e.g. slack.com. A pasted URL is trimmed.

Required string length: 1 - 512

Response

Successful Response

One search and whatever it has found so far.

created_at
string<date-time>
required
domain
string
required
error
string | null
required
error_code
string | null
required
hostnames
string[]
required

Discovered hostnames, newest first sighting first. Empty until the search succeeds.

hostnames_found
integer
required
id
string<uuid>
required
retryable
boolean
required

Whether running the same search again could plausibly work.

rows_created
integer
required
status
enum<string>
required

Where one subdomain search has got to.

Available options:
pending,
running,
succeeded,
failed
table_id
string<uuid> | null
required