シンクラウド ドメインAPI リファレンス

認証中のAPIキー情報を取得

現在認証に使用しているAPIキーの情報を返します。有効期限・サービス種別を確認できます。

すべてのサービス（サーバー / ドメイン / XServer for WordPress）で共通のエンドポイントです。APIキーの疎通確認や、鍵の有効期限が切れていないかの確認に利用できます。

リクエスト例

curl \
  "https://api.shin-server.jp/v1/me" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "service_type": "domain",
  "expires_at": "2027-04-16 00:00:00"
}

ドメイン一覧を取得

APIキーで操作できるドメインの一覧を返します。取得申込の処理中（pending_create）や移管中（transferring）のドメインも含まれます。解約済みの契約は含まれず、同じドメイン名の契約が複数ある場合は代表1件に集約して返します。

ドメイン用のAPIキーはユーザー単位で発行されます。操作範囲が「すべてのドメイン」のキーではユーザーが保有する全ドメイン、「指定ドメインのみ」のキーでは許可されたドメインだけを返します。

現在は全件を返します。将来ページングパラメータを追加する場合も、パラメータ未指定時の挙動（全件返却）は変更しません。

リクエスト例

curl \
  "https://api.shin-server.jp/v1/domain" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "domains": [
    {
      "domain_name": "example.com",
      "expiry_date": "2026-12-31",
      "status": "active",
      "decoded_domain": null
    },
    {
      "domain_name": "xn--wgv71a119e.jp",
      "expiry_date": "2027-03-31",
      "status": "active",
      "decoded_domain": "日本語.jp"
    }
  ]
}

ドメイン詳細を取得

指定したドメインの詳細情報を返します。取得申込の処理中は status が pending_create、移管の進行中は transferring になります（「取得・移管・更新の結果確認」参照）。

パスパラメータ

リクエスト例

curl \
  "https://api.shin-server.jp/v1/domain/{domain_name}" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "domain_name": "example.com",
  "expiry_date": "2026-12-31",
  "status": "active",
  "auto_renew": true,
  "epp_statuses": []
}

ネームサーバーを取得

有効（active）なドメインに設定されているネームサーバーの一覧を返します。

パスパラメータ

リクエスト例

curl \
  "https://api.shin-server.jp/v1/domain/{domain_name}/nameservers" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "nameservers": ["ns1.example.jp", "ns2.example.jp"]
}

ネームサーバーを変更

ドメインのネームサーバーを、送信した内容で全件置き換えます。現在の設定への追加ではないため、設定したいネームサーバーをすべて指定してください。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X PUT \
  "https://api.shin-server.jp/v1/domain/{domain_name}/nameservers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameservers": [
        "ns1.example.jp",
        "ns2.example.jp"
    ]
}'

レスポンスフィールド

レスポンス例

{
  "nameservers": ["ns1.example.jp", "ns2.example.jp"],
  "message": "ネームサーバーを変更しました"
}

DNSレコード一覧を取得

ドメインのDNSレコードを一覧で返します。対応レコードタイプは A / AAAA / CNAME / MX / TXT / NS / SRV です（SOAレコードは取得・編集の対象外）。当社ネームサーバーを利用しているドメインが対象です。

ネームサーバーの設定が必要です: 取得直後のドメインは当社のドメイン用ネームサーバー（ns1.xdomain.ne.jp 〜 ns3.xdomain.ne.jp）に向いていない場合があり、その状態では本APIで設定したDNSレコードは名前解決に反映されません。ネームサーバー設定API（PUT /v1/domain/{domain_name}/nameservers）で当社ドメイン用ネームサーバーへ変更してください。

パスパラメータ

リクエスト例

curl \
  "https://api.shin-server.jp/v1/domain/{domain_name}/dns" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "records": [
    {
      "id": 1,
      "type": "A",
      "host": "www",
      "content": "192.0.2.1",
      "ttl": 3600,
      "priority": 0
    }
  ]
}

DNSレコードを追加

ドメインにDNSレコードを追加します。レスポンスの id は後続の更新・削除で使用します。

ネームサーバーの設定が必要です: 取得直後のドメインは当社のドメイン用ネームサーバー（ns1.xdomain.ne.jp 〜 ns3.xdomain.ne.jp）に向いていない場合があり、その状態では本APIで設定したDNSレコードは名前解決に反映されません。ネームサーバー設定API（PUT /v1/domain/{domain_name}/nameservers）で当社ドメイン用ネームサーバーへ変更してください。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X POST \
  "https://api.shin-server.jp/v1/domain/{domain_name}/dns" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "A",
    "host": "www",
    "content": "192.0.2.1",
    "ttl": 3600,
    "priority": 0
}'

レスポンスフィールド

レスポンス例

{
  "id": 1,
  "type": "A",
  "host": "www",
  "content": "192.0.2.1",
  "ttl": 3600,
  "priority": 0,
  "message": "DNSレコードを追加しました"
}

DNSレコードを変更

既存のDNSレコードを変更します。送信した項目のみ更新され、省略した項目は現在の設定が維持されます。存在しないDNSレコードID、または他のユーザーのDNSレコードIDを指定した場合は 404（RECORD_NOT_FOUND）になります。

ネームサーバーの設定が必要です: 取得直後のドメインは当社のドメイン用ネームサーバー（ns1.xdomain.ne.jp 〜 ns3.xdomain.ne.jp）に向いていない場合があり、その状態では本APIで設定したDNSレコードは名前解決に反映されません。ネームサーバー設定API（PUT /v1/domain/{domain_name}/nameservers）で当社ドメイン用ネームサーバーへ変更してください。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X PUT \
  "https://api.shin-server.jp/v1/domain/{domain_name}/dns/{dns_id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "A",
    "host": "www",
    "content": "192.0.2.2",
    "ttl": 3600,
    "priority": 0
}'

レスポンスフィールド

レスポンス例

{
  "id": 1,
  "type": "A",
  "host": "www",
  "content": "192.0.2.2",
  "ttl": 3600,
  "priority": 0,
  "message": "DNSレコードを更新しました"
}

DNSレコードを削除

指定したDNSレコードを削除します。存在しないDNSレコードID、または他のユーザーのDNSレコードIDを指定した場合は 404（RECORD_NOT_FOUND）になります。

ネームサーバーの設定が必要です: 取得直後のドメインは当社のドメイン用ネームサーバー（ns1.xdomain.ne.jp 〜 ns3.xdomain.ne.jp）に向いていない場合があり、その状態では本APIで設定したDNSレコードは名前解決に反映されません。ネームサーバー設定API（PUT /v1/domain/{domain_name}/nameservers）で当社ドメイン用ネームサーバーへ変更してください。

パスパラメータ

リクエスト例

curl \
  -X DELETE \
  "https://api.shin-server.jp/v1/domain/{domain_name}/dns/{dns_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "message": "DNSレコードを削除しました"
}

Whois情報を取得

有効（active）かつWhois編集に対応しているドメインのWhois登録情報と代理公開設定を返します。属性型JPドメイン（co.jp 等）は対象外です。

パスパラメータ

リクエスト例

curl \
  "https://api.shin-server.jp/v1/domain/{domain_name}/whois" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "domain_name": "example.com",
  "whois_privacy": false,
  "is_whois_privacy_available": true,
  "locked_by_migration": false,
  "fields": {
    "organization_name": "",
    "first_name": "Taro",
    "last_name": "Yamada",
    "postal_code": "1000001",
    "state_province": "Tokyo",
    "city": "Chiyoda",
    "address1": "1-1-1",
    "address2": "",
    "email": "admin@example.com",
    "phone": "+81.9012345678",
    "fax": "",
    "country": "JP",
    "role": ""
  },
  "mail_validation_required": false
}

Whois情報を変更

ドメインのWhois登録情報と代理公開設定を変更します。

fields と whois_privacy の少なくとも一方を指定してください。省略した項目は現在値を維持し、両方を省略すると 422 になります。

代理公開ONでは fields に空のオブジェクトを指定できます。代理公開OFFでは、fields に13キーすべてを含めてください。9項目は値必須（空文字不可）、4項目は値任意（空文字可）です。

メールアドレス有効性確認が未完了のドメイン、および属性型JPドメイン（co.jp 等）は、APIからの変更に対応していません。

レジストラが登録内容を受け付けなかった場合は 409（REGISTRAR_REJECTED）を返します。同じ内容で再試行しても結果は変わらないため、message の内容をご確認のうえ、指定値を見直して再実行してください。レジストラに到達できない場合は 500（REGISTRAR_ERROR）となり、こちらは時間をおいての再試行で回復する可能性があります。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X PUT \
  "https://api.shin-server.jp/v1/domain/{domain_name}/whois" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "whois_privacy": true,
    "fields": {

    }
}'

レスポンスフィールド

レスポンス例

{
  "message": "Whois情報を保存しました。"
}

レジストラロック状態を取得

レジストラロックに対応している有効（active）なドメインの移管ロック状態を返します。ロックが有効な間は他社への移管申請が承認されません。

他社への移管に必要な認証鍵（AuthCode）の取得は、APIでは提供していません。契約管理画面のドメインパネル「別サービスに移管」から取得してください。

パスパラメータ

リクエスト例

curl \
  "https://api.shin-server.jp/v1/domain/{domain_name}/registrar-lock" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "domain_name": "example.com",
  "locked": true,
  "locked_by_migration": false,
  "unlock_blocked": false,
  "warn_on_lock": false
}

レジストラロックを変更

レジストラロックに対応している有効（active）なドメインの移管ロックを設定・解除します。契約種別によっては、解除前に対象ドメインの解約申請が必要です。上位レジストラの変更期間中は操作できません。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X PUT \
  "https://api.shin-server.jp/v1/domain/{domain_name}/registrar-lock" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "locked": true
}'

レスポンスフィールド

レスポンス例

{
  "locked": true,
  "message": "レジストラロックを設定しました"
}

取得可能かを確認（空き確認＋見積）

ドメインが取得可能かどうかと、取得・更新・移管の価格（税込・キャンペーン適用後）を返します。

各APIの expected_total_price には、取得・更新では価格に対象年数を掛けた合計金額、移管では transfer の金額を指定します。

取得できない場合は available が false になり、理由は reason と reason_message で確認できます。prices は、形式不正・取扱対象外TLD等で価格を判定できない場合に null になります。登録済み（reason: registered）の場合は、移管の見積等に利用できる参考価格を返します。プレミアムドメインはAPIから取得できないため、reason に premium が入ります。

クエリパラメータ

リクエスト例

curl \
  "https://api.shin-server.jp/v1/domain/check?domain_name=VALUE" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "domain_name": "example.com",
  "available": true,
  "reason": null,
  "premium": false,
  "prices": {
    "register": 1602,
    "renew": 1602,
    "transfer": 1602,
    "currency": "JPY",
    "campaign_applied": false
  }
}

TLD別価格一覧を取得

ドメイン取得APIに対応しているTLDごとの取得・更新・移管価格（税込）を一覧で返します。

対応TLDは300件を超えるため、必要なTLDだけを取得したい場合は tld パラメータで絞り込んでください。

クエリパラメータ

リクエスト例

curl \
  "https://api.shin-server.jp/v1/domain/pricing" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "prices": [
    {
      "tld": "com",
      "register": 1602,
      "renew": 1602,
      "transfer": 1602,
      "currency": "JPY",
      "campaign_applied": false
    }
  ]
}

ドメインを取得（新規登録）

ドメインの新規取得を申し込みます。属性型JPドメイン（co.jp 等）とプレミアムドメインには対応していません。また、操作範囲が「指定ドメインのみ」のAPIキーからは利用できません（403 FORBIDDEN）。

通常価格はプリペイド残高から引き落とされます。初回限定0円キャンペーンが適用される場合は、クレジットカードを登録済みの会員に限り無料で取得できます。カード未登録の場合は CREDIT_CARD_REQUIRED、同じカードによる無料申込の重複利用対策に該当する場合は FREE_CAMPAIGN_NOT_AVAILABLE を返します。カードの登録・変更は、会員管理画面の「料金のお支払い」→「自動更新設定」から行ってください。

ご利用には、APIキー発行時に「ドメインの新規取得・移管・更新（お申し込み）を許可する」設定を有効にしておく必要があります。この設定を有効にするには、Whois初期値設定の登録とプリペイド残高のご入金が必要です。申込時のWhois情報には、登録済みの「Whois初期値設定」が使用されます。

dry_run が true の場合は、課金・登録を行わず、HTTP 200 で dry_run と total_price を返します。実申請には Idempotency-Key ヘッダーが必要です（UUID推奨）。

実申請はリクエスト内で登録まで同期的に処理され、成功すると HTTP 200 で domain（取得したドメインの情報）を返します。通常は status が active となり、その時点で取得は完了しています。レジストラ側の処理が保留された場合など、まれに status が pending_create のまま 200 が返ることがあります。この場合も申込は受け付けられており、通常は自動で解消されます（解消されない場合はサポートまでお問い合わせください）。その後の状態はドメイン詳細取得API（GET /v1/domain/{domain_name}）の status で確認できます。詳しくは「取得・移管・更新の結果確認」を参照してください。

お支払い完了後にレジストラ側の処理が失敗・保留のまま解消されない場合、自動での返金は行われません。状況の確認・返金のご相談はサポートまでお問い合わせください。

リクエストヘッダー

リクエストボディ

リクエスト例

curl \
  -X POST \
  "https://api.shin-server.jp/v1/domain" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -d '{
    "domain_name": "example.com",
    "years": 1,
    "nameservers": [
        "ns1.example.jp",
        "ns2.example.jp"
    ],
    "expected_total_price": 1602,
    "agree_to_terms": true,
    "dry_run": false
}'

レスポンスフィールド

レスポンス例

{
  "domain": {
    "domain_name": "example.com",
    "status": "active",
    "expiry_date": "2027-08-03",
    "epp_statuses": []
  }
}

レスポンスフィールド（dry_run=true の場合）

課金・登録を行わずに実行可否を検証した結果

レスポンス例（dry_run=true の場合）

{
  "dry_run": true,
  "total_price": 1602
}

他社からの移管を申請

他社で管理しているドメインの移管（トランスファーイン）を申請します。対象は、価格一覧APIの transfer が null ではないTLDです。JPドメイン・属性型JPドメイン・プレミアムドメインには対応していません。移管料金として1年分の更新料金がプリペイド残高から引き落とされ、移管完了時に有効期限が1年延長されます。

ご利用には、APIキー発行時に「ドメインの新規取得・移管・更新（お申し込み）を許可する」設定を有効にしておく必要があります。

dry_run が true の場合は、課金・移管申請を行わず、HTTP 200 で dry_run と total_price を返します。実申請には Idempotency-Key ヘッダーが必要です（UUID推奨）。実申請は同期的に処理され、申請に成功すると HTTP 200 で domain（status: transferring）を返します。

移管はレジストリ側の承認を伴うため、申請後も完了までに時間がかかります。進行状況はドメイン詳細取得API（GET /v1/domain/{domain_name}）の status で確認できます（完了で active、失敗すると transfer_action_required）。進行中の移管が残っている間は再申請できません。詳しくは「取得・移管・更新の結果確認」を参照してください。

お支払い完了後にレジストラ側の処理が失敗・保留のまま解消されない場合、自動での返金は行われません。状況の確認・返金のご相談はサポートまでお問い合わせください。

当社から他社への移管（トランスファーアウト）に必要な認証鍵の取得は、APIでは提供していません。契約管理画面のドメインパネル「別サービスに移管」から取得してください。

パスパラメータ

リクエストヘッダー

リクエストボディ

リクエスト例

curl \
  -X POST \
  "https://api.shin-server.jp/v1/domain/{domain_name}/transfer" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -d '{
    "auth_code": "xxxxxxxxxxxx",
    "expected_total_price": 1602,
    "agree_to_terms": true,
    "dry_run": false
}'

レスポンスフィールド

レスポンス例

{
  "domain": {
    "domain_name": "example.com",
    "status": "transferring",
    "expiry_date": null,
    "epp_statuses": ["pendingTransfer"]
  }
}

レスポンスフィールド（dry_run=true の場合）

課金・移管申請を行わずに実行可否を検証した結果

レスポンス例（dry_run=true の場合）

{
  "dry_run": true,
  "total_price": 1602
}

契約を更新（期限延長）

ドメインの契約期限を延長します。更新できるのは有効（active）なドメインのみです。失効後の更新・復旧はサポートまでご相談ください。料金はプリペイド残高から引き落とされます。二重更新を防ぐため、現在の有効期限（current_expiry_date）の指定が必須です。ご利用には、APIキー発行時に「ドメインの新規取得・移管・更新（お申し込み）を許可する」設定を有効にしておく必要があります。

dry_run が true の場合は、課金・更新を行わず、HTTP 200 で dry_run と total_price を返します。実申請には Idempotency-Key ヘッダーが必要です（UUID推奨）。

実申請はリクエスト内で更新まで同期的に処理され、成功すると HTTP 200 で domain を返します。更新の成否は renewed（true で更新完了）と、expiry_date が previous_expiry_date から延長されていることで判定してください。詳しくは「取得・移管・更新の結果確認」を参照してください。

パスパラメータ

リクエストヘッダー

リクエストボディ

リクエスト例

curl \
  -X POST \
  "https://api.shin-server.jp/v1/domain/{domain_name}/renew" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -d '{
    "years": 1,
    "current_expiry_date": "2026-12-31",
    "expected_total_price": 1602,
    "dry_run": false
}'

レスポンスフィールド

レスポンス例

{
  "domain": {
    "domain_name": "example.com",
    "status": "active",
    "expiry_date": "2027-12-31",
    "epp_statuses": [],
    "renewed": true,
    "previous_expiry_date": "2026-12-31"
  }
}

レスポンスフィールド（dry_run=true の場合）

課金・更新を行わずに実行可否を検証した結果

レスポンス例（dry_run=true の場合）

{
  "dry_run": true,
  "total_price": 1602
}