find-subdomains

Start a subdomain search

Begin reading the public record of subdomains for a domain. Returns immediately with a pending search; poll the search endpoint until it reaches a terminal status. It usually answers in seconds, but a domain the fast index does not cover falls back to reading raw certificate logs, which is slow and frequently has to be retried. That is why this does not answer inline.

post/find-subdomains/searches/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/find-subdomains/searches/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

domainstring required

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

Response

Successful Response

created_atstring date-time required
domainstring required
errorstring nullable required
error_codestring nullable required
hostnamesstring[] 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_foundinteger 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.

idstring uuid required
partialboolean 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.

retryableboolean required

Whether running the same search again could plausibly work.

rows_createdinteger required
rows_to_addinteger 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'pending' | 'running' | 'succeeded' | 'failed' required

Where one subdomain search has got to.

table_idstring uuid nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.