Skip to main content
POST
For server-to-server use, send a Pirehub API key with the domain:dns scope. See Authentication for OAuth support and credential handling. The endpoint queries every supported record type and returns deduplicated records, display-ready sections, per-query resolver status, and a combined status summary. See the Domain DNS guide for resolver selection, record types, cache behavior, status handling, limits, and integration guidance.

Subscription-backed API keys

Paid self-service keys use shared owner credits and the plan’s per-second and concurrent-job limits. Successful results, including cache hits, consume the configured action cost; errors release the reservation. Video jobs settle at completion. Inspect X-ApiKey-Credit-* and X-ApiKey-RateLimit-*. An optional Idempotency-Key prevents repeated synchronous execution/debits; repeated operations return 409 rather than replaying a response. Job starts use requestId instead. See API plans and idempotency for costs, billing periods, headers, error codes and retry rules.

Authorizations

Authorization
string
header
required

OAuth 2.0 Authorization Code with PKCE, issued by Pirehub's Clerk authorization server. Request only the scopes required by the operation.

Headers

Idempotency-Key
string

Self-service keys only. Owner-scoped operation identifier; reuse after admission returns 409 without another debit or execution. USAGE_CONCURRENCY_EXCEEDED retains no new reservation: wait and retry with the same identifier and payload. No response replay. Video jobs use requestId instead.

Required string length: 1 - 80
Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json
domain
string
required

A valid hostname without a URL scheme or path.

Required string length: 1 - 253
Examples:

"example.com"

"www.example.com"

provider
enum<string>
default:google

The DNS-over-HTTPS resolver used for the lookup.

Available options:
google,
cloudflare

Response

The DNS lookup completed. Inspect data.statusSummary.domainExists and individual query statuses for the resolver outcome.

success
boolean
required
data
object
required