domains

GET /v1/domains/{domainId}/settings

Get a domain's registrar settings.

すべての domains エンドポイント

認証

ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/settings \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Auto-renew, registrar transfer lock, DNSSEC and WHOIS privacy for an owned domain. Served from our mirror of the registrar's state rather than a live vendor round-trip, so a detail screen never waits on a third party. Requires `sites.view`. **422 also covers a refusal that will never succeed.** A domain registered through the Cloudflare route has no API-writable transfer lock or WHOIS privacy — Cloudflare exposes neither for a registration made through its registrations endpoint — so the answer names the Cloudflare dashboard and offers support rather than `503 try again`, which is a sentence a customer would act on for ever.

パラメータ

名前タイプ必須これがその内容です
domainId (path)UuidはいThe domain's id.

返信

名前タイプ必須これがその内容です
registrarstringはいThe registrar driver holding this domain (a driver name, never a vendor id).
auto_renewbooleanはいWhether we renew it before expiry. Ours, not the registrar's.
transfer_lockbooleanはいRegistrar transfer lock (`clientTransferProhibited`) — blocks an outbound transfer.
dnssec_enabledbooleanはい
privacy_enabledbooleanはいWHOIS privacy / registrant redaction, where the TLD supports it.

このエンドポイントが返すエラー

401 · 403 · 404 · 422 · 429