Domain SDK
API Reference

DomainClient

Reference for normalized custom-domain lifecycle methods.

MemberReturnsBehavior
providerstringStable provider ID.
capabilitiesmetadataOptional-operation support.
add(hostname, options?)DomainAdd or safely return an existing domain.
get(hostname, options?)DomainRetrieve current provider state.
refresh(hostname, options?)DomainAlias for a fresh get.
list(options?)DomainPageList with limit 1–100 and cursor.
verify(hostname, options?)DomainExplicitly verify when supported.
remove(hostname, options?)voidSafely remove; absent is success.
waitUntilActive(hostname, options?)DomainSequentially poll until active.

Network-aware options accept signal?: AbortSignal.

Read next: Domain.