Domain SDK
API Reference

Domain SDK TypeScript API reference

Reference the typed clients, provider contract, domain model, DNS records, lifecycle status, errors, polling, and isolated testing utilities.

The Domain SDK API reference documents the public TypeScript exports for managing customer domains. Start with createDomainClient, then use the normalized domain types and lifecycle methods regardless of which platform adapter you configure.

Clients and provider contract

createDomainClient

createSubdomainClient

DomainClient

DomainProvider

Models and utilities

Domain

DnsRecord

DomainStatus

DomainSdkError

waitUntilActive

Testing utilities

Security model

Keep provider credentials server-side and tenant ownership in your application.

createDomainClient

Create a stateless client from a provider and optional silent-by-default logger.

On this page

Clients and provider contractModels and utilities