Schemas

Human-readable label for this provider account (shown in your dashboard).

Registrar type.

Auth scheme used by this registrar. Mirrors what GET /providers/auth-config returns for the type — pick the value listed there.

Username / app id / reseller id — depending on registrar. See GET /providers/auth-config.

Password / api-secret — depending on registrar. Stored encrypted; never echoed back.

API token / api-key / appkey — depending on registrar. Stored encrypted; never echoed back.

Optional token TTL (seconds). Used by OAuth-style registrars that issue short-lived tokens; null otherwise.

Route all API traffic for this provider through a proxy.

Required when useProxy: true.

Proxy address in host:port form.

Optional proxy username.

Optional proxy password. Never echoed back.

Maximum concurrent in-flight requests this provider will accept before bridge-sdk throttles. Defaults to 1 (safest); raise for accounts with looser registrar limits.

Whether the worker may attempt orders even when the registrar reports a negative or zero balance. Most registrars reject such orders anyway — leave false unless you have a registrar that explicitly supports it.

Floor (signed) on the registrar balance below which orders are blocked. Only consulted when allowNegativeBalance is true.

Reseller tier level. Required for NICENIC (1, 2, or 3); ignored for every other provider type.

True if the registry requires WHOIS verification for this TLD

True if WHOIS verification has been completed (only meaningful when verificationRequired is true)

Current nameservers set on the domain at the registry. Empty array if none are set yet (registrar default / parking).