API Reference

The DNS.GLOBAL REST API is the source of truth. The web widget, native SDKs, and hosted links are all thin layers over these endpoints.

Base URL

All requests are made to:

https://api.dns.global/v1

Authentication

There are two kinds of credentials:

  • Secret key (sk_live_...) — used server-to-server to mint sessions and manage templates. Never expose it to a browser or mobile client.
  • Session token (sess_...) — short-lived, single-use, backend-minted. Safe to hand to a client for the duration of a connect flow.

See Authentication for the full credential model.

Resources

ResourceDescription
SessionsMint short-lived client session tokens
Provider DetectionIdentify a domain's DNS provider
Domain ConnectionsInitiate and manage connections
OperationsPoll async operation status
TemplatesDefine the records to deploy
WebhooksReceive signed completion events
Error CodesStandard error responses

Conventions

  • All request and response bodies are JSON.
  • Every mutating endpoint accepts an optional Idempotency-Key header.
  • Mutating actions return an operation_id — poll Operations or wait for a webhook.
  • Timestamps are ISO 8601 in UTC.
Was this page helpful?