Skip to main content
POST
Start a subdomain search

Authorizations

X-API-Key
string
header
required

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. At most the per-search cap (5,000 by default): a larger domain is trimmed to its newest names and partial is true.

hostnames_found
integer
required

How many distinct hostnames the search found, before the per-search cap. Larger than len(hostnames) when the cap trimmed the list; use this for the headline count.

id
string<uuid>
required
partial
boolean
required

True when hostnames is a slice of what was found, which is when hostnames_found exceeds len(hostnames). The names kept are the newest first sightings.

retryable
boolean
required

Whether running the same search again could plausibly work.

rows_created
integer
required
rows_to_add
integer
required

How many rows turning this search into a table would add: the hostnames stored, cut to the plan's rows per table. Put it on the create button; 0 until the search succeeds.

status
enum<string>
required

Where one subdomain search has got to.

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