ドメイン

ドメインAPIコマンド一覧

私たちのAPIは、効率性を重視して構築された高度なドメイン管理と取得のツールキットです。Dynadotプラットフォーム全体で設定、管理、登録、入札を行うための50以上のコマンドを備えており、お好みのAPIソフトウェアでアカウントとドメイン設定を完全に制御できます。私たちのドメインAPIはすべてのアカウントで利用可能です。今すぐ始めましょう!

Advanced Domain API をはじめよう

レガシーAPIは廃止予定です。代わりに当社のRESTful APIをご利用ください:

https://www.dynadot.com/domain/api-document

Advanced Domain API へのリクエストは、次のURLに送信されます:

https://api.dynadot.com/api3.xml

セキュリティのためにリクエストは https (セキュアソケット) 経由で送信する必要があります. リクエストには次の2つのパラメータ, 'Key' と 'Command' が必要です. 各コマンドをクリックするとそれに関連するパラメータを確認できます.

アカウントのスペンディングレベルに基づいて、異なるスレッド数を受け取ります。

支出レベルスレッド数レート制限
通常1スレッド60/分 (1/秒)
バルク5スレッド600/分 (10/秒)
スーパーバルク35スレッド6000/分 (100/秒)

 
リクエストパラメータ
説明
KeyAPI にアクセスするためのキー, Dynadot アカウントのコントロールパネルの 'Tools' -> 'API' サイドバーメニューにあります.
Command
ドメイン:
search, register, delete, renew, push, transfer, bulk_register, restore

domain_info, set_whois, set_ns, set_parking, set_forwarding, set_stealth, set_hosting, set_dns2, set_email_forward, set_clear_domain_setting, set_folder, set_note, set_renew_option, set_privacy, tld_price, list_domain, lock_domain, suggestion_search, set_dnssec, get_dnssec, clear_dnssec

cancel_transfer, get_transfer_status, set_transfer_auth_code, authorize_transfer_away, get_transfer_auth_code

get_domain_push_request, set_domain_push_request
連絡先:
create_cn_audit, get_cn_audit_status, create_contact, edit_contact, delete_contact, contact_list, get_contact

set_contact_eu_setting, set_contact_lv_setting, set_contact_lt_setting
ネームサーバー:
get_ns, add_ns, register_ns, set_ns_ip, delete_ns, delete_ns_by_domain, server_list, get_dns
アカウント:
account_info, get_account_balance, set_default_whois, set_default_ns, set_default_parking, set_default_forwarding, set_default_stealth, set_default_hosting, set_default_dns, set_default_dns2, set_default_email_forward, set_clear_default_setting, set_default_renew_option
フォルダ:
create_folder, delete_folder, set_folder_whois, set_folder_ns, set_folder_parking, set_folder_forwarding, set_folder_stealth, set_folder_hosting, set_folder_dns, set_folder_dns2, set_folder_email_forward, set_clear_folder_setting, set_folder_name, set_folder_renew_option, folder_list
アフターマーケット:
add_backorder_request, delete_backorder_request, backorder_request_list

get_open_auctions, get_auction_details, get_auction_bids, place_auction_bid, get_closed_auctions

get_open_backorder_auctions, get_backorder_auction_details, place_backorder_auction_bid, get_closed_backorder_auctions, get_expired_closeout_domains, buy_expired_closeout_domain, get_listings, get_listing_item, buy_it_now, add_new_lead
その他:
set_afternic_confirm_action, set_sedo_confirm_action, get_whois_stats, order_list, set_for_sale, get_order_status, is_processing, transfer_out_domain_list, list_coupons, download_all_listings

XML形式. 受け取るレスポンスには、次のフィールドのうち2つまたは3つが含まれている必要があります:

結果XMLタグ
説明
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
 

検索コマンド

マルチスレッド対応
APIサンドボックス対応

検索コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

検索リクエストパラメータ
説明
domain0 - domain99検索するドメイン名です。通常アカウントは1コマンドにつき1ドメイン、バルクアカウントとスーパーバルクアカウントは最大100ドメインまで指定できます
language0 - language99 (optional)それぞれのドメインの言語タグ。IDNにのみ使用します
show_price (optional)アカウント通貨で価格を表示したい場合は、"1" に設定してください。ドメインが利用可能な場合、そのプレミアム詳細と価格情報が表示されます。
currency (optional)通貨タイプを指定できます。このパラメータでサポートされているのは "USD","CNY", "GBP","EUR","INR","CAD" などです。このパラメータを省略した場合、アカウントのデフォルト通貨を使用します。
結果XMLタグ
説明
<Results></Results>検索コマンドのXMLレスポンスのルートノード
<SearchResponse></SearchResponse>検索レスポンスのタグ
<SearchHeader></SearchHeader>検索ヘッダーのタグ
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<DomainName></DomainName>先ほど検索したドメイン名
<Available></Available>ドメイン名が利用可能な場合
<Price></Price>もし"show_price"を"1"に設定すると、このドメインが利用可能な場合、価格情報が表示されます。
<Language></Language>ドメイン名の言語情報

検索例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
応答 (XML形式)
<Results>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.com</DomainName>
      <Available>yes</Available>
      <Price>77.00 in USD</Price>
    </SearchHeader>
  </SearchResponse>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.net</DomainName>
      <Available>yes</Available>
      <Price>44.00 in USD and domain is not premium</Price>
    </SearchHeader>
  </SearchResponse>
</Results>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
応答 (JSON形式)
{
   "SearchResponse":{
      "ResponseCode":"0",
      "SearchResults":[
         {
            "DomainName":"mydomain.com",
            "Available":"yes",
            "Price":"77.00 in USD"
         },
         {
            "DomainName":"mydomain.net",
            "Available":"yes",
            "Price":"44.00 in USD"
         }
      ]
   }
}
 

登録コマンド

マルチスレッド対応
APIサンドボックス対応

register コマンドを呼び出すと、登録注文を作成して処理します。注文の支払いに十分なアカウント残高が必要です。register コマンドを呼び出す場合は、次のパラメータを含める必要があります:

登録リクエストパラメータ
説明
domain登録したいドメイン名。1回のリクエストにつき登録できるドメインは1つだけです
language (optional)リクエストされたドメインの言語タグ。ドメインがIDNの場合にのみ必要です
durationドメインを登録する期間
registrant_contact (optional)ドメインに使用する登録者連絡先
admin_contact (optional)ドメインで使用したい管理者連絡先
technical_contact (optional)ドメインで使用したいテクニカルコンタクト
billing_contact (optional)ドメインで使用したい請求先連絡先
option0 (if necessary)
.AT, .BE, 登録者名
option1 (if necessary).AT, .BE, 登録者組織 (オプション)
.ATでは、option0、option1、または両方を指定できます
premium (optional)プレミアムドメインを登録したい場合は、"1"に設定します(オプション)
currency (optional)通貨タイプを指定できます。このパラメータでサポートされているのは "USD","CNY", "GBP","EUR","INR","CAD" などです。このパラメータを省略した場合、アカウントのデフォルト通貨を使用します。
coupon (optional)このコマンドに適用したいクーポンコード
結果XMLタグ
説明
<RegisterResponse></RegisterResponse>登録応答のタグ
<RegisterHeader></RegisterHeader>登録ヘッダーのタグ
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<RegisterContent></RegisterContent>登録内容のタグ
<Expiration></Expiration>有効期限のUnix時間(1970年1月1日午前0時UTCからのミリ秒)、resultが"success"の場合にのみ使用されます
<Registration></Registration>Unix時間での登録日(1970年1月1日UTC午前0時からのミリ秒)、resultが "success" の場合にのみ使用されます。

登録例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=register&domain=domain1.net&duration=3&currency=USD
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=register&domain=domain1.net&duration=3&currency=USD
応答 (JSON形式)
{
  "RegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.net",
    "Expiration": 1458379145266
  }
}
 

削除コマンド

マルチスレッド対応
APIサンドボックス対応

削除コマンドを呼び出すと、まだ猶予期間内にあるドメインが削除されます。アカウント残高には登録料が返金されます。更新されたドメイン、または新しいアカウントに移動されたドメインは、APIを通じて削除できません。削除コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

削除リクエストパラメータ
説明
domain削除したいドメイン名, 1回のリクエストにつき削除できるドメインは1つだけです
結果XMLタグ
説明
<DeleteResponse></DeleteResponse>削除応答のタグ
<DeleteHeader></DeleteHeader>削除ヘッダーのタグ
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

削除の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete&domain=domain1.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete&domain=domain1.com
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete&domain=domain1.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete&domain=domain1.com
応答 (JSON形式)
{
  "DeleteResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.com"
  }
}
 

更新コマンド

マルチスレッド対応
APIサンドボックス対応

renewコマンドを呼び出すと、更新注文が作成され処理されます。注文の支払いに十分なアカウント残高が必要です。renewコマンドを呼び出す場合は、次のパラメータを含める必要があります:

更新リクエストパラメータ
説明
domain更新したいドメイン名。1回のリクエストにつき更新できるドメインは1つだけです
durationドメインを更新する年数
year (optional)ドメインの有効期限が切れる年
currency (optional)通貨タイプを指定できます。このパラメータでサポートされているのは "USD","CNY", "GBP","EUR","INR","CAD" などです。このパラメータを省略した場合、アカウントのデフォルト通貨を使用します。
price_check (optional)このパラメータをコマンドに追加すると, このドメインの更新価格の詳細を確認できます. 注意: このパラメータをコマンドに追加しても, 当社のAPIはドメインを更新せず, 価格情報を表示するだけです.
coupon (optional)このコマンドに適用したいクーポンコード
no_renew_if_late_renew_fee_needed (optional)ドメインの更新に延滞更新料が必要な場合に更新を避けるため、このパラメータをコマンドに追加できます。ドメインの更新に延滞更新料が実際に必要な場合、コマンドで "no_renew_if_late_renew_fee_needed = 1" が渡されていれば、ドメインは更新されません。
結果XMLタグ
説明
<RenewResponse></RenewResponse>更新レスポンスのタグです。レスポンスXMLドキュメントのルートノードです
<RenewHeader></RenewHeader>更新ヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<PriceInfo></PriceInfo>価格情報のタグ。status が "price_check_success" の場合にのみ使用されます。
<RenewContent></RenewContent>更新内容のタグ。status が "success" の場合にのみ使用されます。
<Expiration></Expiration>有効期限のUnix時間(1970年1月1日午前0時UTCからのミリ秒)、resultが"success"の場合にのみ使用されます

更新の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
応答 (XML形式)
<RenewResponse>
  <RenewHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RenewHeader>
  <RenewContent>
    <Expiration>73984579834</Expiration>
  </RenewContent>
</RenewResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
応答 (JSON形式)
{
   "RenewResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.com",
      "Expiration":"73984579834"
   }
}
 

プッシュコマンド

マルチスレッド対応
APIサンドボックス対応

プッシュコマンドを呼び出すと、プッシュ注文が作成され処理されます。注文のために、ドメインとアカウントのロックを解除する必要があります。受け取り側のアカウントは、注文を完了するためにドメインを拒否/承認する必要があります。プッシュコマンドを呼び出す場合は、次のパラメータを含める必要があります:

プッシュリクエストパラメータ
説明
domainプッシュしたいドメイン名です. 一括プッシュにも対応しており, ";" でドメインを区切ることができます. 例: domain1.com;domain2.com
receiver_push_username受け取り側アカウントのプッシュユーザー名
currency (optional)通貨タイプを指定できます。このパラメータでサポートされているのは "USD","CNY", "GBP","EUR","INR","CAD" などです。このパラメータを省略した場合、アカウントのデフォルト通貨を使用します。
unlock_domain_for_push(optional)このパラメータを"1"に設定してください。ドメインがロックされている場合は自動的にロックを解除しますので、手動でドメインのロックを解除する必要はありません
receiver_email(optional)受け取り先アカウントのプッシュメール
結果XMLタグ
説明
<PushResponse></PushResponse>プッシュ応答のタグ。応答XMLドキュメントのルートノードです
<PushHeader></PushHeader>プッシュヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

プッシュの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
応答 (XML形式)
<PushResponse>
  <PushHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </PushHeader>
</PushResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
応答 (JSON形式)
{
   "PushResponse":{
      "ResponseCode":"0",
      "Status":"order created"
   }
}
 

移管コマンド

マルチスレッド対応
APIサンドボックス対応

移管コマンドを呼び出すと、移管注文が作成され処理されます。一部のTLDでは、注文を完了するために移管元レジストラの確認が必要になる場合があります。移管コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

移管リクエストパラメータ
説明
domainDynadotに転送したいドメイン名、1回のリクエストにつき1つのドメインのみ転送できます
auth転送リクエストの認証コード.
currency (optional)通貨タイプを指定できます。このパラメータでサポートされているのは "USD","CNY", "GBP","EUR","INR","CAD" などです。このパラメータを省略した場合、アカウントのデフォルト通貨を使用します。
registrant_contact (optional)転送完了時に使用する登録者連絡先です. (すべてのTLDがこの機能をサポートしているわけではありません)
admin_contact (optional)転送完了時に使用する管理者連絡先。(すべてのTLDがこの機能をサポートしているわけではありません)
technical_contact (optional)移管完了時に使用するテクニカルコンタクト。(すべてのTLDがこの機能をサポートしているわけではありません)
billing_contact (optional)移管完了時に使用する請求先連絡先. (すべてのtldがこの機能をサポートしているわけではありません)
premium (optional)プレミアムドメインを移管したい場合は、"1" に設定します(任意)。
privacy (optional)設定したいドメインのプライバシーステータスです, "on" または "off" です. 入力が正しくない場合, または入力がない場合は, アカウントのデフォルトのプライバシーレベルが適用されます
name_servers (optional)ドメインの移管が完了した後に適用するネームサーバーのリストです。ネームサーバーを分割するには "," を使用できます。例: ns1.domain1.com,ns2.domain2.com
coupon (optional)このコマンドに適用したいクーポンコード
結果XMLタグ
説明
<TransferResponse></TransferResponse>転送レスポンスのタグ, これはレスポンスXMLドキュメントのルートノードです
<TransferHeader></TransferHeader>トランスファーヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

移管例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<TransferResponse>
  <TransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
    <DomainName>domain1.com</DomainName>
    <OrderId>1234567</OrderId>
  </TransferHeader>
</TransferResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
応答 (JSON形式)
{
  "TransferResponse": {
    "ResponseCode": 0,
    "Status": "order created",
    "DomainName": "domain1.com",
    "OrderId": "1234567"
  }
}
 

一括登録コマンド

マルチスレッド対応
APIサンドボックス対応

bulk register コマンドを呼び出すと, 登録注文が作成され処理されます. 注文の支払いに十分なアカウント残高が必要です. bulk register コマンドを呼び出す場合は, 以下のパラメータを含める必要があります:

一括登録リクエストパラメータ
説明
domain0-domain99登録したいドメイン名(複数可)。1リクエストにつき最大100ドメインまで登録できます
premium (optional)プレミアムドメインを登録したい場合は、"1"に設定します(オプション)
currency (optional)通貨タイプを指定できます。このパラメータでサポートされるのは"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"などです。このパラメータを指定しない場合、アカウントのデフォルト通貨を使用します
coupon (optional)このコマンドに適用したいクーポンコード
結果XMLタグ
説明
<BulkRegisterResponse></BulkRegisterResponse>一括登録レスポンスのタグ
<BulkRegisterHeader></BulkRegisterHeader>一括登録ヘッダーのタグ
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<BulkRegisterContent></BulkRegisterContent>一括登録内容のタグ
<Expiration></Expiration>有効期限のUnix時間(1970年1月1日午前0時UTCからのミリ秒)、resultが"success"の場合にのみ使用されます
<Result></Result>登録アクションの結果
<Message></Message>登録アクションのエラーメッセージ。result が "error" の場合にのみ使用されます。

一括登録の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<BulkRegisterResponse>
  <BulkRegisterHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BulkRegisterHeader>
  <BulkRegisterContent>
    <BulkRegister>
      <RegisterResult>
        <DomainName>domain0.com</DomainName>
        <Expiration>1234567890</Expiration>
        <Result>success</Result>
        <Message>-</Message>
      </RegisterResult>
      <RegisterResult>
        <DomainName>domain1.com</DomainName>
        <Expiration>-</Expiration>
        <Result>error</Result>
        <Message>not_available</Message>
      </RegisterResult>
    </BulkRegister>
  </BulkRegisterContent>
</BulkRegisterResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
応答 (JSON形式)
{
  "BulkRegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BulkRegister": [
      {
        "DomainName": "domain0.com",
        "Expiration": "1234567890",
        "Result": "success",
        "Message": "-"
      },
      {
        "DomainName": "domain1.com",
        "Expiration": "-",
        "Result": "error",
        "Message": "not_available"
      }
    ]
  }
}
 

ドメイン情報コマンド

マルチスレッド対応
APIサンドボックス対応

このコマンドは XML および JSON 形式でのみ利用できます:

ドメイン情報リクエストパラメータ
説明
domainリクエストごとに1つのドメインのみ許可されています
結果XMLタグ
説明
<DomainInfoResponse></DomainInfoResponse>レスポンスXMLドキュメントのルートノード
<DomainInfoResponseHeader></DomainInfoResponseHeader>レスポンスヘッダー
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<DomainInfoContent></DomainInfoContent>レスポンス内容
<Domain></Domain>ドメイン
<Name></Name>ドメイン名
<Expiration></Expiration>Unix時間でのドメイン有効期限 (1970年1月1日UTC午前0時からの経過ミリ秒)
<Registration></Registration>Unix時間でのドメイン登録日 (1970年1月1日UTC午前0時からのミリ秒)
<NameServerSettings></NameServerSettings>ドメインのネームサーバー設定
<Type></Type>ドメインのネームサーバータイプ
<WithAds></WithAds>ドメインのパーキングページが必要な場合
<Whois></Whois>Whois情報
<Registrant></Registrant>登録者情報
<ContactId></ContactId>連絡先 ID
<Admin></Admin>管理者情報
<Technical></Technical>技術情報
<Billing></Billing>請求情報
<Locked></Locked>ロックされているかどうか
<Disabled></Disabled>有効ステータス
<UdrpLocked></UdrpLocked>UDRP がロックされているかどうか
<UdrpLocked></UdrpLocked>UDRP がロックされているかどうか
<RegistrantUnverified></RegistrantUnverified>登録者未確認
<Hold></Hold>クライアント/レジストラ保留ステータス
<Privacy></Privacy>プライバシーステータス
<isForSale></isForSale>販売ステータス
<RenewOption></RenewOption>更新オプション
<Note></Note>注意
<Folder></Folder>フォルダ情報
<FolderId></FolderId>フォルダID
<FolderName></FolderName>フォルダ名

ドメイン情報の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=domain_info&domain=domain1.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=domain_info&domain=domain1.com
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<DomainInfoResponse>
  <DomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </DomainInfoHeader>
  <DomainInfoContent>
    <Domain>
      <Name>domain1.com</Name>
      <Expiration>1361430589062</Expiration>
      <Registration>1234567890123</Registration>
      <NameServerSettings>
        <Type>Dynadot Parking</Type>
        <WithAds>Yes</WithAds>
      </NameServerSettings>
      <Whois>
        <Registrant>
          <ContactId>0</ContactId>
        </Registrant>
        <Admin>
          <ContactId>0</ContactId>
        </Admin>
        <Technical>
          <ContactId>0</ContactId>
        </Technical>
        <Billing>
          <ContactId>0</ContactId>
        </Billing>
      </Whois>
      <Locked>yes</Locked>
      <Disabled>no</Disabled>
      <UdrpLocked>no</UdrpLocked>
      <RegistrantUnverified>no</RegistrantUnverified>
      <Hold>no</Hold>
      <Privacy>none</Privacy>
      <isForSale>yes</isForSale>
      <RenewOption>no renew option</RenewOption>
      <Note/>
      <Folder>
        <FolderId>-1</FolderId>
        <FolderName>(no folder)</FolderName>
      </Folder>
      <Status>active</Status>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=domain_info&domain=domain1.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=domain_info&domain=domain1.com
応答 (JSON形式)
{
  "DomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainInfo": {
      "Name": "domain1.com",
      "Expiration": "1361430589062",
      "Registration": "1234567890123",
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      },
      "Whois": {
        "Registrant": {
          "ContactId": "0"
        },
        "Admin": {
          "ContactId": "0"
        },
        "Technical": {
          "ContactId": "0"
        },
        "Billing": {
          "ContactId": "0"
        }
      },
      "Locked": "yes",
      "Disabled": "no",
      "UdrpLocked": "no",
      "RegistrantUnverified": "no",
      "Hold": "no",
      "Privacy": "none",
      "isForSale": "yes",
      "RenewOption": "no renew option",
      "Note": "",
      "Folder": {
        "FolderId": "-1",
        "FolderName": "(no folder)"
      },
      "Status": "active"
    }
  }
}
 

Whoisコマンドを設定

マルチスレッド対応
APIサンドボックス対応

set Whoisコマンドを呼び出す場合、以下のパラメータを含める必要があります:

Whoisリクエストパラメータを設定
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
registrant_contactドメインの登録者情報
admin_contactドメインの管理者情報
technical_contactドメインの技術情報
billing_contactドメインの請求情報
結果XMLタグ
説明
<SetWhoisResponse></SetWhoisResponse>レスポンスXMLドキュメントのルートノード
<SetWhoisHeader></SetWhoisHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

Whoisの例を設定

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
応答 (XML形式)
<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
応答 (JSON形式)
{
   "SetWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

ネームサーバー設定コマンド

マルチスレッド対応
APIサンドボックス対応

set name serversコマンドを呼び出す場合は, 以下のパラメータを含める必要があります:

ネームサーバー設定リクエストパラメータ
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
ns0 - ns12ドメインで使用するネームサーバーを設定します。最大13台のネームサーバーを指定できますが、それらはすでにアカウント内に存在している必要があります
結果XMLタグ
説明
<SetNsResponse></SetNsResponse>ネームサーバー設定レスポンスのタグ, これはレスポンスXMLドキュメントのルートノードです
<SetNsHeader></SetNsHeader>ネームサーバー設定レスポンスヘッダーのタグ
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

NS設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
応答 (JSON形式)
{
  "SetNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

パーキング設定コマンド

マルチスレッド対応
APIサンドボックス対応

set parking コマンドを呼び出す場合は、次のパラメータを含める必要があります:

パーキング設定リクエストパラメータ
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
with_ads (optional)サードパーティの広告を望まない場合は、このパラメータを "no" で使用できます。
結果XMLタグ
説明
<SetParkingResponse></SetParkingResponse>set parking レスポンスのタグ。レスポンス XML ドキュメントのルートノードです
<SetParkingHeader></SetParkingHeader>パーキングフォルダヘッダーを設定
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

パーキング設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_parking&domain=domain1.com&with_ads=no
応答 (XML形式)
<SetParkingResponse>
  <SetParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetParkingHeader>
</SetParkingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_parking&domain=domain1.com&with_ads=no
応答 (JSON形式)
{
   "SetParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

転送コマンドを設定

マルチスレッド対応
APIサンドボックス対応

転送設定コマンドを呼び出す場合, 以下のパラメータを含める必要があります:

転送設定のリクエストパラメータ
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
forward_urlドメインの転送先にしたいURLです。パラメータは必ず~でなければならない点に注意してください エンコード済み API呼び出しが適切に解釈されるように.
is_temp (optional)設定したいドメインの転送ステータス。デフォルト値は "temporary" です。永続的に転送したい場合は、このパラメータに "no" を指定してください
結果XMLタグ
説明
<SetForwardingResponse></SetForwardingResponse>レスポンスXMLドキュメントのルートノード
<SetForwardingHeader></SetForwardingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

転送設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
応答 (XML形式)
<SetForwardingResponse>
  <SetForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetForwardingHeader>
</SetForwardingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
応答 (JSON形式)
{
   "SetForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

ステルスコマンドを設定

マルチスレッド対応
APIサンドボックス対応

set stealth コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

ステルスリクエストパラメータ設定
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
stealth_urlドメインの転送先にしたいURLです。パラメータは必ず~でなければならない点に注意してください エンコード済み API呼び出しが適切に解釈されるように.
stealth_title (optional)ページのタイトル
結果XMLタグ
説明
<SetStealthResponse></SetStealthResponse>レスポンスXMLドキュメントのルートノード
<SetStealthHeader></SetStealthHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

ステルス設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
応答 (XML形式)
<SetStealthResponse>
  <SetStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetStealthHeader>
</SetStealthResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
応答 (JSON形式)
{
   "SetStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Set Hosting コマンド

マルチスレッド対応
APIサンドボックス対応

set hostingコマンドを呼び出す場合は、以下のパラメータを含める必要があります:

ホスティング設定リクエストパラメータ
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
hosting_type希望するホスティングの種類。"advanced" と "basic" から選択できます。
mobile_view_onhosting_type が "advanced" の場合にのみ、このパラメータを "yes" として使用できます
結果XMLタグ
説明
<SetHostingResponse></SetHostingResponse>レスポンスXMLドキュメントのルートノード
<SetHostingHeader></SetHostingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

ホスティング設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
応答 (XML形式)
<SetHostingResponse>
  <SetHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetHostingHeader>
</SetHostingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
応答 (JSON形式)
{
   "SetHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

DNS2設定コマンド

マルチスレッド対応
APIサンドボックス対応

set DNS2 コマンドを呼び出す場合, 以下のパラメータを含める必要があります:

SET_DNS2 コマンドを実行すると, デフォルトでは現在の DNS 設定が上書きされることにご注意ください. この動作を変更して, 代わりに新しい DNS 設定を追加するには, オプションのパラメータ add_dns_to_current_setting を使用できます.

DNS2リクエストパラメータを設定
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
main_record_type0 - main_record_type19 (optional)メインレコードタイプ。"a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email" のいずれかである必要があります。
main_record0 - main_record19ドメインのDNSレコードを指定します
main_recordx0 - main_recordx19Mx 距離, 転送タイプ(301 は "1", 302 は "2"), ステルス転送タイトルまたはメールエイリアス, main_record_type が "forward","mx","stealth","email" の場合に必要です.
subdomain0 - subdomain99 (optional)サブドメインレコード (オプション)
sub_record_type0 - sub_record_type99サブドメインレコードタイプは、"a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"email" のいずれかである必要があります
sub_record0 - sub_record99サブドメインのIPアドレスまたはターゲットホスト
sub_recordx0 - sub_recordx99MX距離、転送タイプ、ステルス転送のタイトルまたはメールエイリアス。main_record_type が "forward","mx","stealth","email" の場合に必要です
ttl (optional)生存時間
add_dns_to_current_setting (optional)新しいDNS設定を既存のDNS設定に追加したい場合. これを "1" に設定してください (任意)
結果XMLタグ
説明
<SetDnsResponse></SetDnsResponse>レスポンスXMLドキュメントのルートノード
<SetDnsHeader></SetDnsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

DNS2設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
応答 (JSON形式)
{
  "SetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

DNSSEC設定コマンド

マルチスレッド対応
APIサンドボックス対応

Set Dnssec コマンドを呼び出すと、ドメインの DNSSEC を設定します。このコマンドは XML と JSON 形式でのみ利用できます。このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

ドメイン名に基づいて、Option 内の対応するパラメータ値を入力するかどうかを選択できます。

オプション1 : domain_name , key_tag , digest_type , digest , algorithm

オプション 2 : domain_name , flags , public_key , algorithm

注: 該当するラベルの番号をパラメータの値として選択してください(該当する場合)。

Dnssecリクエストパラメータの設定
説明
domain_nameDNSSECを設定する必要があるドメイン名
key_tagキータグ
digest_typeデジタル署名タイプを表すには、次のリストから番号を選択できます: SHA-1(1) SHA-256(2) GOSTR 34.11-94 (3) SHA-384(4)
digest選択したダイジェストタイプに対応する値を入力してください
algorithm次のリストから数字を選択して、デジタル署名アルゴリズムを指定できます:RSA/MD5(1) Diffie-Hellman (2) DSA/SHA-1(3) Elliptic Curve (4) RSA/SHA-1(5) DSA-NSEC3-SHA1(6) RSASHA1-NSEC3-SHA1(7) RSA/SHA-256(8) RSA/SHA-512(10) GOSTR 34.10-2001(12) ECDSA Curve P-256 with SHA-256(13 ECDSA Curve P-384 with SHA-384(14) ED25519(15 ED448(16) Indirect (252) Private DNS (253 Private OID (254)
flagsデジタル署名記号を表す番号を、以下のリストから選択できます: ZSK(256) KSK(257)
public_key公開鍵はbase64エンコーディングである必要があります。
結果XMLタグ
説明
<SetDnssecResponse></SetDnssecResponse>レスポンスのルートノード
<SetDnssecHeader></SetDnssecHeader>DNSSECヘッダーを設定
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

DNSSEC設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnssecResponse>
  <SetDnssecHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnssecHeader>
  <SetDnssecContent/>
</SetDnssecResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
応答 (JSON形式)
{
  "SetDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Dnssecクリアコマンド

マルチスレッド対応
APIサンドボックス対応

Dnssecクリアコマンドを呼び出すと、ドメインのDnssecをクリアします。このコマンドはXML形式とJSON形式でのみ利用できます。このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

Clear Dnssec リクエストパラメータ
説明
domain_nameDnssecをクリアする対象のドメイン名

Dnssecクリアの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=clear_dnssec&domain_name=domain-haha1.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=clear_dnssec&domain_name=domain-haha1.com
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<ClearDnssecResponse>
  <ClearDnssecHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ClearDnssecHeader>
</ClearDnssecResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=clear_dnssec&domain_name=domain-haha1.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=clear_dnssec&domain_name=domain-haha1.com
応答 (JSON形式)
{
  "ClearDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

メール転送設定コマンド

マルチスレッド対応
APIサンドボックス対応

set email forward コマンドを呼び出す場合は, 以下のパラメータを含める必要があります:

メール転送設定リクエストのパラメータ
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
forward_type転送タイプ。"donot": メールを転送しない、"mx": メールを別のメールホストに配信(MXレコード)、"forward": メールを別のメールホストに配信
username0 - username9ユーザー名, "forward_type" が "forward" の場合にのみ使用されます
exist_email0 - exist_email9既存のメールアドレス。"forward_type" が "forward" の場合にのみ使用されます
mx_host0 - mx_host2メールホスト。"forward_type" が "mx" の場合にのみ使用されます。
mx_distance0 - mx_distance2Distance0は最高優先度で、"forward_type" が "mx" の場合にのみ使用されます。
結果XMLタグ
説明
<SetEmailForwardingResponse></SetEmailForwardingResponse>レスポンスXMLドキュメントのルートノード
<SetEmailForwardingHeader></SetEmailForwardingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

メール転送設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
応答 (XML形式)
<SetEmailForwardingResponse>
  <SetEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetEmailForwardingHeader>
</SetEmailForwardingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
応答 (JSON形式)
{
   "SetEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

ドメイン設定クリアコマンドを設定

マルチスレッド対応
APIサンドボックス対応

set clear domain settingコマンドを呼び出す場合、以下のパラメータを含める必要があります:

ドメイン設定をクリアするリクエストパラメータ
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
serviceクリアしたいサービス。"forward"、"stealth"、"email_forwarding"、"dns"、"dnssec"、"nameservers" のいずれかです
結果XMLタグ
説明
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>レスポンスXMLドキュメントのルートノード
<SetClearDomainSettingHeader></SetClearDomainSettingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

Clear Domain設定の設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
応答 (XML形式)
<SetClearDomainSettingResponse>
  <SetClearDomainSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
応答 (JSON形式)
{
   "SetClearDomainSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

フォルダ設定コマンド

マルチスレッド対応
APIサンドボックス対応

set folder コマンドを呼び出す場合は、次のパラメータを含める必要があります:

フォルダ設定リクエストパラメータ
説明
domain更新するドメイン名。1回のリクエストにつき1つのドメインのみ設定できます
folderドメインを移動したいフォルダ名。ドメインをデフォルトフォルダに移動する場合は、フォルダ名に "Default" を使用します。フォルダ名は大文字と小文字を区別します。たとえば、"Folder1" と "folder1" は異なるフォルダ名です。
folder_id (optional)ドメインの移動先フォルダID
結果XMLタグ
説明
<SetFolderResponse></SetFolderResponse>set folder レスポンスのタグ, それはレスポンスXMLドキュメントのルートノードです
<SetFolderHeader></SetFolderHeader>フォルダヘッダー設定
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

フォルダ設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder&domain=domian1.com&folder=folder1
応答 (XML形式)
<SetFolderResponse>
  <SetFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHeader>
</SetFolderResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder&domain=domian1.com&folder=folder1
応答 (JSON形式)
{
   "SetFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

ノート設定コマンド

マルチスレッド対応
APIサンドボックス対応

set note コマンドを呼び出す場合, 次のパラメータを含める必要があります:

メモ設定リクエストパラメータ
説明
domain設定したいドメイン, 1回のリクエストにつき1つのドメインのみ設定できます
noteドメインに設定するノート。nullにすることができます。
結果XMLタグ
説明
<SetNoteResponse></SetNoteResponse>レスポンスXMLドキュメントのルートノード
<SetNoteHeader></SetNoteHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

メモ設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
応答 (XML形式)
<SetNoteResponse>
  <SetNoteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNoteHeader>
</SetNoteResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
応答 (JSON形式)
{
   "SetNoteResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

更新オプション設定

マルチスレッド対応
APIサンドボックス対応

set renew option コマンドを呼び出す場合は, 以下のパラメータを含める必要があります:

更新オプションのリクエストパラメータを設定
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
renew_option"donot"、"auto"、"reset" のいずれかになります。
結果XMLタグ
説明
<SetRenewOptionResponse></SetRenewOptionResponse>レスポンスXMLドキュメントのルートノード
<SetRenewOptionHeader></SetRenewOptionHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

更新オプション設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetRenewOptionResponse>
  <SetRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetRenewOptionHeader>
</SetRenewOptionResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
応答 (JSON形式)
{
  "SetRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

プライバシー設定コマンド

マルチスレッド対応
APIサンドボックス対応

set privacyコマンドを呼び出す場合, 以下のパラメータを含める必要があります:

プライバシー設定リクエストパラメータ
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
option設定したいドメインのプライバシーステータスです, "full", "partial", または "off" のいずれかです
whois_privacy_option設定するドメインの WHOIS プライバシーステータスは、"yes" または "no" のいずれかです
結果XMLタグ
説明
<SetPrivacyResponse></SetPrivacyResponse>レスポンスXMLドキュメントのルートノード
<SetPrivacyHeader></SetPrivacyHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

プライバシー設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
応答 (XML形式)
<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
応答 (JSON形式)
{
   "SetPrivacyResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

TLD価格

マルチスレッド対応
APIサンドボックス対応

この機能は XML および JSON 形式でのみ利用可能です:

TLD価格のリクエストパラメータ
説明
currency (optional)戻り値の通貨です。"usd"、"eur"、"cny" のいずれかであり、デフォルト通貨はアカウント設定の API デフォルト通貨です。
count_per_page (optional)1ページに表示されるエンティティ数
page_index (optional)どのページのエンティティを表示しますか
sort (optional)並べ替えパラメータの値として、次のオプションから1つ選択してください:
* 選択していない場合は、デフォルトの並べ替えを使用します。
1) RankAsc (デフォルト)
2) ランク降順
3) 名前昇順
4) 名前降順
5) SalesAsc
6) 販売説明
7) LaunchDateAsc
8) ローンチ日説明
9) CountAsc
10) 件数降順
11) レジストリ昇順
12) レジストリ説明
結果XMLタグ
説明
<TldPriceResponse></TldPriceResponse>レスポンスXMLドキュメントのルートノード
<TldPriceResponseHeader></TldPriceResponseHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<TldPriceContent></TldPriceContent>レスポンス内容
<TldContent></TldContent>TLD情報
<Tld></Tld>トップレベルドメイン
<Usage></Usage>TLDの使用
<Price></Price>この tld の価格情報. サブタグを含みます: : 価格の単位 : 登録価格 : 更新価格 : 転送価格
<Privacy></Privacy>このtldがwhoisプライバシーをサポートしている場合
<GracePeriod></GracePeriod>このTLDの猶予期間情報。サブタグを含みます: : 猶予期間情報の単位 : 更新猶予期間 : 猶予期間の削除
<IDN></IDN>この TLD が国際化ドメイン名をサポートしている場合
<Restrictions></Restrictions>ドメイン名

TLD価格の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=tld_price&currency=USD
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=tld_price&currency=USD
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<TldPriceResponse>
  <TldPriceResponseHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <PriceLevel>Regular Pricing</PriceLevel>
    <Currency>USD</Currency>
  </TldPriceResponseHeader>
  <TldPriceContent>
    <TldContent>
      <Tld>com</Tld>
      <Usage>General</Usage>
      <Price>
        <Unit>(Price/1 year)</Unit>
        <Register>15.00</Register>
        <Renew>15.00</Renew>
        <Transfer>15.00</Transfer>
        <Restore>10.00</Restore>
      </Price>
      <Privacy>10.00</Privacy>
      <GracePeriod>
        <Unit>10.00</Unit>
        <Renew>10.00</Renew>
        <Delete>30</Delete>
        <Restore>YES</Restore>
      </GracePeriod>
      <IDN>YES</IDN>
      <Restrictions>--</Restrictions>
      <OnSale>Yes</OnSale>
      <maxDuration>10</maxDuration>
      <minDuration>1</minDuration>
    </TldContent>
  </TldPriceContent>
</TldPriceResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=tld_price&currency=USD
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=tld_price&currency=USD
応答 (JSON形式)
{
  "TldPriceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "PriceLevel": "Regular Pricing",
    "Currency": "USD",
    "TldPrice": [
      {
        "Tld": "com",
        "Usage": "General",
        "IDN": "YES",
        "Restrictions": "--",
        "OnSale": "Yes",
        "Privacy": "10.00",
        "Price": {
          "Unit": "(Price/1 year)",
          "Register": "15.00",
          "Renew": "15.00",
          "Transfer": "15.00",
          "Restore": "10.00"
        },
        "GracePeriod": {
          "Unit": "10.00",
          "Renew": "10.00",
          "Delete": "30",
          "Restore": "YES"
        },
        "maxDuration": 10,
        "minDuration": 1
      }
    ]
  }
}
 

ドメイン一覧取得コマンド

マルチスレッド対応
APIサンドボックス対応

この機能は XML および JSON 形式でのみ利用可能です:

ドメインリクエストパラメータの一覧
説明
customer_id (optional)顧客IDでデータをフィルタリングする(このパラメータはリセラーのみが使用できます)
count_per_page (optional)1ページに表示されるエンティティ数
page_index (optional)どのページのエンティティを表示しますか
sort (optional)並べ替えパラメータの値として、次のオプションから1つ選択してください:
* 選択していない場合は、デフォルトの並べ替えを使用します。
1) 件数昇順 (デフォルト)
2) 件数降順
3) 名前昇順
4) 名前降順
結果XMLタグ
説明
<ListDomainInfoResponse></ListDomainInfoResponse>レスポンスXMLドキュメントのルートノード
<ListDomainInfoHeader></ListDomainInfoHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<ListDomainInfoContent></ListDomainInfoContent>レスポンス内容
<DomainInfoList></DomainInfoList>ドメイン情報リスト
<DomainInfo></DomainInfo>ドメイン情報
<Domain></Domain>ドメイン
<Name></Name>ドメイン名
<Expiration></Expiration>Unix時間でのドメイン有効期限 (1970年1月1日UTC午前0時からの経過ミリ秒)
<Registration></Registration>Unix時間でのドメイン登録日 (1970年1月1日UTC午前0時からのミリ秒)
<NameServerSettings></NameServerSettings>ネームサーバー設定
<Type></Type>ネームサーバー設定タイプ
<WithAds></WithAds>広告の有無
<Whois></Whois>Whois情報
<Registrant></Registrant>登録者情報
<ContactId></ContactId>連絡先 ID
<Admin></Admin>管理者情報
<Technical></Technical>技術情報
<Billing></Billing>請求情報
<Locked></Locked>ロックされているかどうか
<Disabled></Disabled>有効ステータス
<Hold></Hold>クライアント/レジストラ保留ステータス
<Privacy></Privacy>プライバシーステータス
<isForSale></isForSale>販売ステータス
<RenewOption></RenewOption>更新オプション
<Note></Note>注意
<Folder></Folder>フォルダ情報
<FolderId></FolderId>フォルダID
<FolderName></FolderName>フォルダ名

ドメイン一覧の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=list_domain
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=list_domain
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<ListDomainInfoResponse>
  <ListDomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ListDomainInfoHeader>
  <ListDomainInfoContent>
    <DomainInfoList>
      <DomainInfo>
        <Domain>
          <Name>domain-exp140.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>0</ContactId>
            </Registrant>
            <Admin>
              <ContactId>0</ContactId>
            </Admin>
            <Technical>
              <ContactId>0</ContactId>
            </Technical>
            <Billing>
              <ContactId>0</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
          <Status>active</Status>
        </Domain>
        <Domain>
          <Name>domain-exp141.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>1</ContactId>
            </Registrant>
            <Admin>
              <ContactId>2</ContactId>
            </Admin>
            <Technical>
              <ContactId>3</ContactId>
            </Technical>
            <Billing>
              <ContactId>4</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
          <Status>moved</Status>
        </Domain>
      </DomainInfo>
    </DomainInfoList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=list_domain
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=list_domain
応答 (JSON形式)
{
  "ListDomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "MainDomains": [
      {
        "Name": "domain-exp140.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "0"
          },
          "Admin": {
            "ContactId": "0"
          },
          "Technical": {
            "ContactId": "0"
          },
          "Billing": {
            "ContactId": "0"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        },
        "Status": "active"
      },
      {
        "Name": "domain-exp141.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "1"
          },
          "Admin": {
            "ContactId": "2"
          },
          "Technical": {
            "ContactId": "3"
          },
          "Billing": {
            "ContactId": "4"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        },
        "Status": "moved"
      }
    ]
  }
}
 

ドメインロックコマンド

マルチスレッド対応
APIサンドボックス対応

lock domain コマンドを呼び出す場合は, 以下のパラメータを含める必要があります:

ドメインロックリクエストパラメータ
説明
domainロックしたいドメイン名。1リクエストにつき1つのドメインのみ入力できます
結果XMLタグ
説明
<LockDomainResponse></LockDomainResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<LockDomainHeader></LockDomainHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

ドメインロックの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=lock_domain&domain=domain4.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=lock_domain&domain=domain4.com
応答 (XML形式)
<LockDomainResponse>
   <LockDomainHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </LockDomainHeader>
</LockDomainResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=lock_domain&domain=domain4.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=lock_domain&domain=domain4.com
応答 (JSON形式)
{
   "LockDomainResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Suggestion Search コマンド

マルチスレッド対応
APIサンドボックス対応

Suggestion Search コマンドを呼び出すと、指定したドメイン名を購入します。このコマンドは XML および JSON 形式でのみ利用できます。このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

Suggestion Search リクエストパラメータ
説明
domain検索したいドメインです。1回のリクエストで入力できるドメインは1つだけです
tlds (optional)検索結果に含める TLD のみ
結果XMLタグ
説明
<SuggestionSearchResponse></SuggestionSearchResponse>Suggestion Search レスポンスのタグで、レスポンス XML ドキュメントのルートノードです
<SuggestionSearchHeader></SuggestionSearchHeader>Suggestion Search ヘッダー
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

サジェスト検索の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
サンドボックスリクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SuggestionSearchResponse>
  <SuggestionSearchHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SuggestionSearchHeader>
  <SuggestionSearchContent>
    <SuggestionSearch>
      <Domain>test1.com</Domain>
      <Domain>test2.com</Domain>
      <Domain>test3.net</Domain>
      <Domain>test4.net</Domain>
    </SuggestionSearch>
  </SuggestionSearchContent>
</SuggestionSearchResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
サンドボックスリクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
応答 (JSON形式)
{
  "SuggestionSearchResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Domains": [
      "test1.com",
      "test2.com",
      "test3.net",
      "test4.net"
    ]
  }
}
 

移管キャンセルコマンド

マルチスレッド対応
APIサンドボックス対応

このコマンドを使用すると、注文内の転送項目をキャンセルできます。キャンセル転送コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

転送リクエストのキャンセルパラメータ
説明
domain転送をキャンセルしたいドメイン名。1リクエストにつき1ドメインのみ入力できます
order_id転送オーダーID。別のAPI get_transfer_statusから取得できます。
結果XMLタグ
説明
<CancelTransferResponse></CancelTransferResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<CancelTransferHeader></CancelTransferHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

転送キャンセルの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=cancel_transfer&domain=domain4.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=cancel_transfer&domain=domain4.com
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<CancelTransferResponse>
  <CancelTransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CancelTransferHeader>
</CancelTransferResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=cancel_transfer&domain=domain4.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=cancel_transfer&domain=domain4.com
応答 (JSON形式)
{
  "CancelTransferResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

転送ステータス取得コマンド

マルチスレッド対応
APIサンドボックス対応

get transfer status コマンドを呼び出す場合, 次のパラメータを含める必要があります:

転送ステータス取得リクエストパラメータ
説明
domain転送ステータスを取得したいドメイン名。1回のリクエストにつき1つのドメインのみ入力できます
transfer_typeトランスファーステータスを取得したいトランスファータイプ (転入または転出)
結果XMLタグ
説明
<GetTransferStatusResponse></GetTransferStatusResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<GetTransferStatusHeader></GetTransferStatusHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetTransferStatusContent></GetTransferStatusContent>レスポンス内容
<TransferList></TransferList>移管リスト
<Transfer></Transfer>移管情報
<OrderId></OrderId>注文ID
<TransferStatus></TransferStatus>ドメインの転送ステータス。'none'または'approved'の場合は、転送をキャンセルできます。'waiting'の場合は、転送が既に開始されていることを意味します。'auth code needed'の場合は、認証コードが不正であることを意味し、別のAPI SET_TRANSFER_AUTHを使用して認証コードを再送信できます。その他にもいくつかのステータスがあります。メールでお知らせするか、当社のエンジニアによる確認が必要です。

トランスファーステータス取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferStatusResponse>
  <GetTransferStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetTransferStatusHeader>
  <GetTransferStatusContent>
    <TransferList>
      <Transfer>
        <OrderId>testorderid</OrderId>
        <TransferStatus>teststatus</TransferStatus>
      </Transfer>
      <Transfer>
        <OrderId>testorderid2</OrderId>
        <TransferStatus>teststatus2</TransferStatus>
      </Transfer>
    </TransferList>
  </GetTransferStatusContent>
</GetTransferStatusResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
応答 (JSON形式)
{
  "GetTransferStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "TransferList": [
      {
        "OrderId": "testorderid",
        "TransferStatus": "teststatus"
      },
      {
        "OrderId": "testorderid2",
        "TransferStatus": "teststatus2"
      }
    ]
  }
}
 

転送注文コマンドの転送認証コードを設定

マルチスレッド対応
APIサンドボックス対応

転送注文を処理するための認証コードを更新できるコマンドです。set transfer auth code コマンドを呼び出す場合は、次のパラメータを含める必要があります。

転送認証コードのリクエストパラメータの設定
説明
domain移管認証を更新するドメイン名, 1リクエストにつき1つのドメインのみ入力できます
auth_code再送信したいauth_code
order_id転送オーダーID。別のAPI get_transfer_statusから取得できます。
結果XMLタグ
説明
<GetTransferStatusResponse></GetTransferStatusResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<GetTransferStatusHeader></GetTransferStatusHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

移管認証コード設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
応答 (XML形式)
<SetTransferAuthCodeResponse>
   <SetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
応答 (JSON形式)
{
   "SetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

転出承認コマンド

マルチスレッド対応
APIサンドボックス対応
転出承認リクエストパラメータ
説明
domain転送を許可したいドメイン名。1リクエストにつき1つのドメインのみ入力できます
order_id移管したいドメインのDynadot order_id
authorize転出を承認するには、"approve" に設定します。転出を拒否するには、"deny" に設定します。
結果XMLタグ
説明
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<Result></Result>転送アウェイの承認結果

転出承認の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<AuthorizeTransferAwayResponse>
  <AuthorizeTransferAwayHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <Result>away_approved</Result>
  </AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
応答 (JSON形式)
{
  "AuthorizeTransferAwayResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Result": "away_approved"
  }
}
 

移管認証コード取得コマンド

マルチスレッド対応
APIサンドボックス対応

認証コードをリクエストする前に、ドメインとアカウントのロックを解除する必要があります。

転送認証コード取得リクエストパラメータ
説明
domain転送認証コードを取得したいドメイン名, 1回のリクエストにつき1つのドメインのみ入力できます
new_code (optional)新しい移管認証コードを生成
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)移管のためにドメインのロックを解除したい場合は、"1" に設定します。リクエストが正常に処理されると、ドメインのロックが解除されます。
結果XMLタグ
説明
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<AuthCode></AuthCode>認証コードはドメイン転送を開始するために使用されます。

移管認証コード取得例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferAuthCodeResponse>
  <GetTransferAuthCodeHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <AuthCode>testauthcode</AuthCode>
  </GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
応答 (JSON形式)
{
  "GetTransferAuthCodeResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AuthCode": "testauthcode"
  }
}
 

ドメインプッシュリクエスト取得コマンド

マルチスレッド対応
APIサンドボックス対応

ドメインプッシュリクエスト取得コマンドを呼び出すと、ドメインプッシュリクエストを取得できます。このコマンドはXML形式とJSON形式でのみ利用可能です。

ドメインプッシュリクエスト取得のリクエストパラメータ
説明
N/A 追加のパラメータは不要です
結果XMLタグ
説明
<GetDomainPushRequestResponse></GetDomainPushRequestResponse>レスポンスのルートノード
<GetDomainPushRequestHeader></GetDomainPushRequestHeader>ドメインプッシュリクエストヘッダーを取得
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetDomainPushRequestContent></GetDomainPushRequestContent>レスポンス内容
<PushDomain></PushDomain>プッシュドメイン
<PushDomainName></PushDomainName>ドメイン名をプッシュ

ドメインプッシュリクエスト取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_domain_push_request
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_domain_push_request
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetDomainPushRequestResponse>
  <GetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDomainPushRequestHeader>
  <GetDomainPushRequestContent>
    <PushDomain>
      <PushDomainName>haha.com</PushDomainName>
    </PushDomain>
    <PushDomain>
      <PushDomainName>haha1.com</PushDomainName>
    </PushDomain>
  </GetDomainPushRequestContent>
</GetDomainPushRequestResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_domain_push_request
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_domain_push_request
応答 (JSON形式)
{
  "GetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "pushDomainName": "[haha.com,haha1.com]"
  }
}
 

ドメインプッシュリクエスト設定コマンド

マルチスレッド対応
APIサンドボックス対応

ドメインプッシュリクエスト設定コマンドを呼び出すと、ドメインプッシュリクエストが設定されます。このコマンドはXMLおよびJSON形式でのみ利用可能です。このコマンドを呼び出す場合は、以下のパラメータを含める必要があります:

ドメインプッシュリクエストのリクエストパラメータを設定
説明
domains処理対象の注文のドメイン名
action処理する注文のアクション。"accept" または "decline" を選択できます。
結果XMLタグ
説明
<SetDomainPushRequestResponse></SetDomainPushRequestResponse>レスポンスのルートノード
<SetDomainPushRequestHeader></SetDomainPushRequestHeader>ドメインプッシュ設定リクエストヘッダー
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

ドメインプッシュ設定リクエストの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetDomainPushRequestResponse>
  <SetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetDomainPushRequestHeader>
  <SetDomainPushRequestContent/>
</SetDomainPushRequestResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
応答 (JSON形式)
{
  "SetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Create CN Audit コマンド

マルチスレッド対応
APIサンドボックス対応

このコマンドを使用すると, 連絡先の CN 監査を作成できます. create cn audit コマンドを呼び出す場合は, 次のパラメータを含める必要があります:

CN監査リクエストパラメータの作成
説明
contact_id監査を開始したいコンタクトレコードID。1回のリクエストにつき入力できるコンタクトIDは1件のみです
contact_type連絡先の種類は、"Individual" または "Enterprise" のいずれかです
individual_id_type自然人IDのタイプ, 想定される値 (値の説明) は次のとおりです:
JGZ(中華人民共和国の軍人身分証明書)
SFZ(中華人民共和国の身分証)
HZ (パスポート)
GAJMTX (香港・マカオ往来通行証)
TWJMTX(台湾住民が大陸に出入りするための旅行証)
WJLSFZ (中華人民共和国外国人永久居留身分証)
GAJZZ (香港, マカオの居住許可証)
TWJZZ (台湾居住者用の居留許可)
QT (その他)
individual_license_id自然人IDのライセンス番号
individual_url自然人ライセンスIDの書類。サーバー上のファイルURL。jpg, gif, png, jpegのみ許可されています
enterprise_id_type (Mandatory when contact type is "Enterprise")エンタープライズIDタイプ、期待される値(値の説明)は次のとおりです:
ORG (組織コード証明書)
YYZZ (事業許可証)
TYDM (統一社会信用コード証明書)
BDDM (軍事コード指定)
JDDWFW (軍の有償外部サービス許可)
SYDWFR(公共機関法人証明書)
WGCZJG (外国企業の常駐代表機関登録フォーム)
SHTTFR (社会団体法人登記証明書)
ZJCS (宗教活動サイト登録証明書)
MBFQY(民間非企業団体登録証明書)
JJHFR (ファンド法人登録証明書)
LSZY (法律事務所の業務許可証)
WGZHWH (中国における外国文化センターの登録証明書)
WLCZJG (外国政府観光部門常駐代表事務所承認登録証明書)
SFJD (司法専門ライセンス)
JWJG (海外組織証明書)
SHFWJG (社会サービス機関登録証明書)
MBXXBX (私立学校許可証)
YLJGZY (医療機関執業許可証)
GZJGZY (公証機関業務許可証)
BJWSXX (中国にある外国大使館職員の子女のための北京学校許可)
QTTYDM (その他-統一社会信用コードの証明書)
QT (その他)
enterprise_license_id (Mandatory when contact type is "Enterprise")企業ドキュメントのライセンス番号
enterprise_url (Mandatory when contact type is "Enterprise")エンタープライズライセンスの書類です. サーバー上のファイルURLです. jpg, gif, png, jpeg のみ使用できます
結果XMLタグ
説明
<CreateCnAuditResponse></CreateCnAuditResponse>レスポンスXMLドキュメントのルートノード
<CreateCnAuditHeader></CreateCnAuditHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

Cn 監査例の作成

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<CreateCnAuditResponse>
  <CreateCnAuditHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateCnAuditHeader>
</CreateCnAuditResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
応答 (JSON形式)
{
  "CreateCnAuditResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Cn 監査ステータス取得コマンド

マルチスレッド対応
APIサンドボックス対応

get cn audit status コマンドを呼び出す場合は, 次のパラメータを含める必要があります:

Cn監査ステータス取得リクエストパラメータ
説明
contact_id監査ステータスを取得したい連絡先レコード ID, リクエストごとに 1 つの contactId のみ入力できます
gtldcnnic-gtld の審査結果を照会する場合は、このパラメータを 1 に設定してください
結果XMLタグ
説明
<GetCnAuditStatusResponse></GetCnAuditStatusResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<GetCnAuditStatusHeader></GetCnAuditStatusHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<CnAuditStatus></CnAuditStatus>cnnic監査記録の監査ステータス。'processing'、'waiting for cnnic'、または'failed'のいずれかになります。失敗した場合は、メールを送信します。
<FailedReason></FailedReason>審査が通らない場合、失敗理由が表示されます

Cn監査ステータスの取得例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_cn_audit_status&contact_id=testcontactid
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetCnAuditStatusResponse>
  <GetCnAuditStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <CnAuditStatus>pass</CnAuditStatus>
  </GetCnAuditStatusHeader>
</GetCnAuditStatusResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_cn_audit_status&contact_id=testcontactid
応答 (JSON形式)
{
  "GetCnAuditStatusResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "CnAuditStatus": "pass"
  }
}
 

連絡先作成コマンド

マルチスレッド対応
APIサンドボックス対応

create contactコマンドを呼び出す場合,以下のパラメータを含める必要があります:

コンタクト作成リクエストパラメータ
説明
organization (optional)組織情報
name名前
emailメール
phonenum電話番号
phonecc電話番号の国コード
faxnum (optional)FAX番号
faxcc (optional)FAX国コード
address1住所1
address2 (optional)住所 2
city市区町村
state (optional)州
zip郵便番号
country国
結果XMLタグ
説明
<CreateContactResponse></CreateContactResponse>レスポンスXMLドキュメントのルートノード
<CreateContactHeader></CreateContactHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<CreateContactContent></CreateContactContent>新しい連絡先 ID。ステータスが "success" の場合にのみ使用されます

コンタクト作成例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
応答 (XML形式)
<CreateContactResponse>
  <CreateContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateContactHeader>
  <CreateContactContent>
    <ContactId>1234</ContactId>
  </CreateContactContent>
</CreateContactResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
応答 (JSON形式)
{
   "CreateContactResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "CreateContactContent":{
         "ContactId":"0"
      }
   }
}
 

連絡先編集コマンド

マルチスレッド対応
APIサンドボックス対応

edit contact コマンドを呼び出す場合は、次のパラメータを含める必要があります:

コンタクト編集リクエストパラメータ
説明
contact_id編集したい連絡先のID
organization (optional)組織情報
name名前
emailメール
phonenum電話番号
phonecc電話番号の国コード
faxnum (optional)FAX番号
faxcc (optional)FAX国コード
address1住所1
address2 (optional)住所 2
city市区町村
state州
zip郵便番号
country国
結果XMLタグ
説明
<EditContactResponse></EditContactResponse>レスポンスXMLドキュメントのルートノード
<EditContactHeader></EditContactHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<EditContactContent></EditContactContent>レスポンス内容
<ContactId></ContactId>連絡先のID

連絡先を編集する例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
応答 (JSON形式)
{
  "EditContactResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "EditContactContent": {
      "ContactId": "0"
    }
  }
}
リクエスト (CSV形式)https://api.dynadot.com/api3.html?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
サンドボックスリクエスト (CSV形式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
応答 (CSV形式)
ok,

success,
,
 

連絡先削除コマンド

マルチスレッド対応
APIサンドボックス対応

delete contact コマンドを呼び出す場合は、次のパラメータを含める必要があります:

連絡先削除リクエストパラメータ
説明
contact_id削除したいコンタクトのID。カンマで区切られていることを確認してください
結果XMLタグ
説明
<DeleteContactResponse></DeleteContactResponse>レスポンスXMLドキュメントのルートノード
<DeleteContactHeader></DeleteContactHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

コンタクト削除の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_contact&contact_id=0
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_contact&contact_id=0
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteContactResponse>
  <DeleteContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteContactHeader>
</DeleteContactResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_contact&contact_id=0
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_contact&contact_id=0
応答 (JSON形式)
{
  "DeleteContactResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

コンタクトリストコマンド

マルチスレッド対応
APIサンドボックス対応

このコマンドは XML および JSON 形式でのみ利用できます:

コンタクトリストリクエストパラメータ
説明
N/A追加のパラメータは不要です
結果XMLタグ
説明
<ContactListResponse></ContactListResponse>レスポンスXMLドキュメントのルートノード
<ContactListHeader></ContactListHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<ContactListContent></ContactListContent>レスポンス内容
<ContactList></ContactList>連絡先リスト
<Contact></Contact>連絡先情報
<ContactId></ContactId>連絡先ID
<Organization></Organization>連絡先の組織
<Name></Name>名前
<Email></Email>メール
<PhoneCc></PhoneCc>電話番号の国コード
<PhoneNum></PhoneNum>電話番号
<FaxCc></FaxCc>FAX国コード
<FaxNum></FaxNum>FAX番号
<Address1></Address1>住所1
<Address2></Address2>住所 2
<City></City>市区町村
<State></State>州
<ZipCode></ZipCode>郵便番号
<Country></Country>国
<GtldVerified></GtldVerified>gTLD認証ステータス

連絡先リストの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=contact_list
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=contact_list
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<ContactListResponse>
  <ContactListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ContactListHeader>
  <ContactListContent>
    <ContactList>
      <Contact>
        <ContactId>0</ContactId>
        <Organization/>
        <Name>Jack tester</Name>
        <Email></Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>test street</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
      <Contact>
        <ContactId>1</ContactId>
        <Organization/>
        <Name>John tester</Name>
        <Email></Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>123.456.7890</PhoneNum>
        <FaxCc>1</FaxCc>
        <FaxNum>123.456.7890</FaxNum>
        <Address1>high Way first</Address1>
        <Address2/>
        <City>San Francisco</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>yes</GtldVerified>
      </Contact>
    </ContactList>
  </ContactListContent>
</ContactListResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=contact_list
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=contact_list
応答 (JSON形式)
{
  "ContactListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ContactList": [
      {
        "ContactId": "0",
        "Organization": "",
        "Name": "Jack tester",
        "Email": "",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "test street",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "no"
      },
      {
        "ContactId": "1",
        "Organization": "",
        "Name": "John tester",
        "Email": "",
        "PhoneCc": "1",
        "PhoneNum": "123.456.7890",
        "FaxCc": "1",
        "FaxNum": "123.456.7890",
        "Address1": "high Way first",
        "Address2": "",
        "City": "San Francisco",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "yes"
      }
    ]
  }
}
 

コンタクト取得コマンド

マルチスレッド対応
APIサンドボックス対応

このコマンドは XML および JSON 形式でのみ利用できます:

連絡先取得リクエストパラメータ
説明
contact_idコンタクトのID
結果XMLタグ
説明
<GetContactResponse></GetContactResponse>レスポンスXMLドキュメントのルートノード
<GetContactHeader></GetContactHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetContactContent></GetContactContent>レスポンス内容
<Contact></Contact>連絡先情報
<ContactId></ContactId>連絡先ID
<Organization></Organization>連絡先の組織
<Name></Name>名前
<Email></Email>メール
<PhoneCc></PhoneCc>電話番号の国コード
<PhoneNum></PhoneNum>電話番号
<FaxCc></FaxCc>FAX国コード
<FaxNum></FaxNum>FAX番号
<Address1></Address1>住所1
<Address2></Address2>住所 2
<City></City>市区町村
<State></State>州
<ZipCode></ZipCode>郵便番号
<Country></Country>国
<GtldVerified></GtldVerified>gTLD認証ステータス

連絡先取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_contact&contact_id=10000
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_contact&contact_id=10000
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetContactResponse>
  <GetContactHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetContactHeader>
  <GetContactContent>
    <GetContact>
      <Contact>
        <ContactId>12345</ContactId>
        <Organization>org</Organization>
        <Name>name</Name>
        <Email></Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>address1</Address1>
        <Address2>address2</Address2>
        <City>city</City>
        <State>state</State>
        <ZipCode>zipcode</ZipCode>
        <Country>country</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
    </GetContact>
  </GetContactContent>
</GetContactResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_contact&contact_id=10000
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_contact&contact_id=10000
応答 (JSON形式)
{
  "GetContactResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetContact": {
      "ContactId": "12345",
      "Organization": "org",
      "Name": "name",
      "Email": "",
      "PhoneCc": "1",
      "PhoneNum": "555.555.5233",
      "FaxCc": "",
      "FaxNum": "",
      "Address1": "address1",
      "Address2": "address2",
      "City": "city",
      "State": "state",
      "ZipCode": "zipcode",
      "Country": "country",
      "GtldVerified": "no"
    }
  }
}
 

連絡先EU設定コマンド

マルチスレッド対応
APIサンドボックス対応

set contact eu setting コマンドを呼び出す場合は、次のパラメータを含める必要があります:

Set Contact EU Setting リクエストパラメータ
説明
contact_id編集したい連絡先のID
country_of_citizenshipEU 加盟国である必要があります, 加盟国の国コードには次が含まれます :
AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, GR, HU, IS, IE, IT, LV, LI, LT, LU, MT, NL, NO, PL, PT, RO, SK, SI, ES, SE
結果XMLタグ
説明
<SetContactEUSettingResponse></SetContactEUSettingResponse>レスポンスXMLドキュメントのルートノード
<SetContactEUSettingHeader></SetContactEUSettingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<SetContactEUSettingContent></SetContactEUSettingContent>レスポンス内容
<ContactId></ContactId>連絡先のID

連絡先EU設定の設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
  <SetContactEUSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactEUSettingHeader>
  <SetContactEUSettingContent>
    <ContactId>0</ContactId>
  </SetContactEUSettingContent>
</SetContactEUSettingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
応答 (JSON形式)
{
  "SetContactEUSettingResponse": {
    "ResponseCode: ": "0",
    "Status": "Success",
    "SetContactEUSettingContent": {
      "ContactId: ": "0"
    }
  }
}
 

連絡先LV設定コマンド

マルチスレッド対応
APIサンドボックス対応

set contact lv settingコマンドを呼び出す場合、以下のパラメータを含める必要があります:

連絡先LV設定リクエストパラメータを設定
説明
contact_id編集したい連絡先のID
registration_number- 個人の場合は、ラトビアの識別番号を入力してください。
- 会社やその他の法人の場合は、ラトビア企業登録局が発行した登録番号を入力してください。
vat_number (optional)欧州連合加盟国に登録された外国法人のVAT番号 (ラトビア企業も含みます)
結果XMLタグ
説明
<SetContactLvSettingResponse></SetContactLvSettingResponse>レスポンスXMLドキュメントのルートノード
<SetContactLvSettingHeader></SetContactLvSettingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<SetContactLvSettingContent></SetContactLvSettingContent>レスポンス内容
<ContactId></ContactId>連絡先のID

コンタクトLv設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
  <SetContactLvSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLvSettingHeader>
  <SetContactLvSettingContent>
    <ContactId>0</ContactId>
  </SetContactLvSettingContent>
</SetContactLvSettingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
応答 (JSON形式)
{
  "SetContactLvSettingResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetContactLvSettingContent": {
      "ContactId: ": "0"
    }
  }
}

コンタクトLV設定の例

リクエスト (CSV形式)https://api.dynadot.com/api3.html?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
サンドボックスリクエスト (CSV形式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
応答 (CSV形式)
ok,success,0
 

連絡先LT設定を設定するコマンド

マルチスレッド対応
APIサンドボックス対応

連絡先LT設定を設定するコマンドを呼び出す場合は、次のパラメータを含める必要があります:

連絡先LT設定を設定するリクエストパラメータ
説明
contact_id編集したい連絡先のID
organization_code連絡先組織が設定された後にのみ、連絡先組織コードを設定できます。
結果XMLタグ
説明
<SetContactLtSettingResponse></SetContactLtSettingResponse>レスポンスXMLドキュメントのルートノード
<SetContactLtSettingHeader></SetContactLtSettingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<SetContactLtSettingContent></SetContactLtSettingContent>レスポンス内容
<ContactId></ContactId>連絡先のID

連絡先Lt設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLtSettingResponse>
  <SetContactLtSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLtSettingHeader>
  <SetContactLtSettingContent>
    <ContactId>0</ContactId>
  </SetContactLtSettingContent>
</SetContactLtSettingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
応答 (JSON形式)
{
  "SetContactLtSettingResponse": {
    "ResponseCode:": "0",
    "Status": "Success",
    "SetContactLtSettingContent": {
      "ContactId": "0"
    }
  }
}
 

ネームサーバー取得コマンド

マルチスレッド対応
APIサンドボックス対応

get name serverコマンドを呼び出す場合、以下のパラメータを含める必要があります:

ネームサーバーリクエストパラメータ取得
説明
domainネームサーバー情報を取得したいドメイン, 1回のリクエストにつき1つのドメインのネームサーバー情報のみ取得できます.
結果XMLタグ
説明
<GetNsResponse></GetNsResponse>レスポンスXMLドキュメントのルートノード
<GetNsHeader></GetNsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<NsContent></NsContent>レスポンス内容
<Host></Host>サーバーのホスト名
<NsName></NsName>サーバーの名前

NS取得例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_ns&domain=mydomain.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_ns&domain=mydomain.com
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetNsResponse>
  <GetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetNsHeader>
  <NsContent>
    <Host>ns1.mydomain.com</Host>
    <Host>ns2.mydomain.com</Host>
  </NsContent>
</GetNsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_ns&domain=mydomain.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_ns&domain=mydomain.com
応答 (JSON形式)
{
  "GetNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "NsContent": {
      "Host0": "ns1.mydomain.com",
      "Host1": "ns2.mydomain.com"
    }
  }
}
 

ネームサーバー追加コマンド

マルチスレッド対応
APIサンドボックス対応

add name server コマンドを呼び出す場合は、次のパラメータを含める必要があります:

ネームサーバー追加リクエストパラメータ
説明
host追加したいネームサーバーのホスト名
結果XMLタグ
説明
<AddNsResponse></AddNsResponse>レスポンスXMLドキュメントのルートノード
<AddNsHeader></AddNsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<AddNsContent></AddNsContent>レスポンス内容
<Server></Server>設定したサーバー
<Host></Host>新しいサーバーのホスト名
<ServerId></ServerId>新しいサーバーのID

NSの追加例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_ns&host=ns1.mydomain.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_ns&host=ns1.mydomain.com
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<AddNsResponse>
  <AddNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddNsHeader>
  <AddNsContent>
    <Server>
      <Host>ns1.mydomain.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </AddNsContent>
</AddNsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=add_ns&host=ns1.mydomain.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_ns&host=ns1.mydomain.com
応答 (JSON形式)
{
  "AddNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AddNsContent": {
      "Server": {
        "Host": "ns1.mydomain.com",
        "ServerId": 0
      }
    }
  }
}
 

ネームサーバー登録コマンド

マルチスレッド対応
APIサンドボックス対応

ネームサーバー登録コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

ネームサーバー登録リクエストのパラメータ
説明
hostご自身のネームサーバーのホスト名
ip自分のネームサーバーのIPアドレス
結果XMLタグ
説明
<RegisterNsResponse></RegisterNsResponse>レスポンスXMLドキュメントのルートノード
<RegisterNsHeader></RegisterNsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<RegisterNsContent></RegisterNsContent>レスポンス内容
<Server></Server>サーバータグ
<Host></Host>ホスト名
<ServerId></ServerId>サーバーID

ネームサーバー登録の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
応答 (XML形式)
<RegisterNsResponse>
  <RegisterNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterNsHeader>
  <RegisterNsContent>
    <Server>
      <Host>domain1.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </RegisterNsContent>
</RegisterNsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
応答 (JSON形式)
{
   "RegisterNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "RegisterNsContent":{
         "Server":{
            "Host":"ndomain1.com",
            "ServerId":"0"
         }
      }
   }
}
 

ネームサーバーIP設定コマンド

マルチスレッド対応
APIサンドボックス対応

set name server IP コマンドを呼び出す場合は、次のパラメータを含める必要があります:

ネームサーバーIP設定リクエストパラメータ
説明
server_id設定したいネームサーバーのID
ip0 - ip9ネームサーバーに設定したいIPアドレス。1回のリクエストにつき9個のIPを設定でき、カンマで区切る必要があります
結果XMLタグ
説明
<SetNsIpResponse></SetNsIpResponse>レスポンスXMLドキュメントのルートノード
<SetNsIpHeader></SetNsIpHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

ネームサーバーIP設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
応答 (XML形式)
<SetNsIpResponse>
  <SetNsIpHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsIpHeader>
</SetNsIpResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
応答 (JSON形式)
{
   "SetNsIpResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

ネームサーバー削除コマンド

マルチスレッド対応
APIサンドボックス対応

ネームサーバー削除コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

ネームサーバー削除リクエストパラメータ
説明
server_id削除するネームサーバーの ID。カンマで区切られていることを確認してください
結果XMLタグ
説明
<DeleteNsResponse></DeleteNsResponse>レスポンスXMLドキュメントのルートノード
<DeleteNsHeader></DeleteNsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

NS削除例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns&server_id=0
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_ns&server_id=0
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns&server_id=0
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_ns&server_id=0
応答 (JSON形式)
{
  "DeleteNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

ドメイン指定でネームサーバーを削除するコマンド

マルチスレッド対応
APIサンドボックス対応

ドメインによるネームサーバー削除コマンドを呼び出す場合、以下のパラメータを含める必要があります:

ドメインによるネームサーバー削除リクエストパラメータ
説明
server_domainネームサーバーの名前. 例: ns1.testnameserver.com
結果XMLタグ
説明
<DeleteNsResponse></DeleteNsResponse>レスポンスXMLドキュメントのルートノード
<DeleteNsHeader></DeleteNsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

ドメイン別ネームサーバー削除の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
応答 (XML形式)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
応答 (JSON形式)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

サーバーリストコマンド

マルチスレッド対応
APIサンドボックス対応

このコマンドは XML および JSON 形式でのみ利用できます:

サーバーリストリクエストパラメータ
説明
N/A追加のパラメータは不要です
結果XMLタグ
説明
<ServerListResponse></ServerListResponse>レスポンスXMLドキュメントのルートノード
<ServerListHeader></ServerListHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<ServerListContent></ServerListContent>レスポンス内容
<NameServerList></NameServerList>ネームサーバー一覧
<List></List>
<Server></Server>
<ServerId></ServerId>サーバーID
<ServerName></ServerName>サーバー名
<ServerIp></ServerIp>サーバーIP

サーバーリストの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=server_list
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=server_list
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<ServerListResponse>
  <ServerListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ServerListHeader>
  <ServerListContent>
    <NameServerList>
      <List>
        <Server>
          <ServerId>0</ServerId>
          <ServerName>ns1.com</ServerName>
        </Server>
        <Server>
          <ServerId>1</ServerId>
          <ServerName>domain1.com</ServerName>
          <ServerIp>192.168.1.1</ServerIp>
          <ServerIp>1.1.1.1</ServerIp>
        </Server>
      </List>
    </NameServerList>
  </ServerListContent>
</ServerListResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=server_list
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=server_list
応答 (JSON形式)
{
  "ServerListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ServerList": [
      {
        "ServerId": "0",
        "ServerName": "ns1.com"
      },
      {
        "ServerId": "1",
        "ServerName": "domain1.com",
        "ServerIps": [
          {
            "Ip": "192.168.1.1"
          },
          {
            "Ip": "1.1.1.1"
          }
        ]
      }
    ]
  }
}
 

ドメインネームサーバー設定取得コマンド

マルチスレッド対応
APIサンドボックス対応

get domain nameservers settings コマンドを呼び出す場合は、次のパラメータを含める必要があります:

ドメイン ネームサーバー設定取得リクエスト パラメータ
説明
domainネームサーバー設定を取得したいドメイン。1回のリクエストで取得できるネームサーバー設定は1ドメイン分のみです。
結果XMLタグ
説明
<GetDnsResponse></GetDnsResponse>レスポンスXMLドキュメントのルートノード
<GetDnsHeader></GetDnsHeader>レスポンスヘッダー
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetDnsContent></GetDnsContent>レスポンス内容
<NameServerSettings></NameServerSettings>ドメインのネームサーバー設定
<Type></Type>ドメインのネームサーバータイプ

ドメインネームサーバー設定取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_dns&domain=mydomain.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_dns&domain=mydomain.com
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetDnsResponse>
  <GetDnsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDnsHeader>
  <GetDnsContent>
    <NameServerSettings>
      <Type>Dynadot Parking</Type>
      <WithAds>Yes</WithAds>
    </NameServerSettings>
  </GetDnsContent>
</GetDnsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_dns&domain=mydomain.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_dns&domain=mydomain.com
応答 (JSON形式)
{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}
 

アカウント情報コマンド

マルチスレッド対応
APIサンドボックス対応

このコマンドは XML および JSON 形式でのみ利用できます:

アカウント情報リクエストパラメータ
説明
N/A追加のパラメータは不要です
結果XMLタグ
説明
<AccountInfoResponse></AccountInfoResponse>レスポンスXMLドキュメントのルートノード
<AccountInfoHeader></AccountInfoHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<AccountInfoContent></AccountInfoContent>レスポンス内容
<AccountInfo></AccountInfo>アカウント情報
<Username></Username>ユーザー名
<ForumName></ForumName>フォーラム名
<Contact></Contact>連絡先情報
<Organization></Organization>組織
<Organization></Organization>レスポンスヘッダー
<Name></Name>あなたの名前
<Email></Email>メール
<PhoneCc></PhoneCc>電話番号の国コード
<PhoneNum></PhoneNum>電話番号
<Address1></Address1>住所1
<Address2></Address2>住所 2
<City></City>市区町村
<State></State>州
<ZipCode></ZipCode>郵便番号
<Country></Country>国
<CustomerSince></CustomerSince>顧客登録日
<AccountLock></AccountLock>アカウントロック
<TotalSpending></TotalSpending>合計支出
<PriceLevel></PriceLevel>価格レベル
<AccountBalance></AccountBalance>アカウント残高
<CustomTimeZone></CustomTimeZone>カスタムタイムゾーン
<DefaultSettings></DefaultSettings>デフォルト設定
<DefaultWhois></DefaultWhois>デフォルトのWhois
<DefaultRegistrant></DefaultRegistrant>デフォルト登録者
<ContactId></ContactId>連絡先ID
<DefaultAdmin></DefaultAdmin>デフォルト管理者
<DefaultTechnical></DefaultTechnical>デフォルトのテクニカル
<DefaultBilling></DefaultBilling>デフォルトの請求
<Type></Type>ネームサーバータイプ
<WithAds></WithAds>広告の有無

アカウント情報の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=account_info
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=account_info
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<AccountInfoResponse>
  <AccountInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AccountInfoHeader>
  <AccountInfoContent>
    <AccountInfo>
      <Username>testname</Username>
      <ForumName>test forum name</ForumName>
      <AvatarUrl>test avatar url</AvatarUrl>
      <Contact>
        <Organization/>
        <Name>testname test</Name>
        <Email></Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 test road</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90000</ZipCode>
        <Country>US</Country>
      </Contact>
      <CustomerSince>1364888735253</CustomerSince>
      <AccountLock>on</AccountLock>
      <TotalSpending>$0.00</TotalSpending>
      <PriceLevel>Regular Pricing</PriceLevel>
      <AccountBalance>$70.02</AccountBalance>
      <CustomTimeZone>PST</CustomTimeZone>
      <DefaultSettings>
        <DefaultWhois>
          <DefaultRegistrant>
            <ContactId>0</ContactId>
          </DefaultRegistrant>
          <DefaultAdmin>
            <ContactId>0</ContactId>
          </DefaultAdmin>
          <DefaultTechnical>
            <ContactId>0</ContactId>
          </DefaultTechnical>
          <DefaultBilling>
            <ContactId>0</ContactId>
          </DefaultBilling>
        </DefaultWhois>
        <DefaultNameServerSettings>
          <Type>Dynadot Parking</Type>
          <WithAds>yes</WithAds>
        </DefaultNameServerSettings>
      </DefaultSettings>
    </AccountInfo>
  </AccountInfoContent>
</AccountInfoResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=account_info
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=account_info
応答 (JSON形式)
{
  "AccountInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AccountInfo": {
      "Username": "testname",
      "ForumName": "test forum name",
      "AvatarUrl": "test avatar url",
      "Contact": {
        "Organization": "",
        "Name": "testname test",
        "Email": "",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "1 test road",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90000",
        "Country": "US"
      },
      "CustomerSince": "1364888735253",
      "AccountLock": "on",
      "TotalSpending": "$0.00",
      "PriceLevel": "Regular Pricing",
      "AccountBalance": "$70.02",
      "CustomTimeZone": "PST",
      "DefaultSettings": {
        "DefaultWhois": {
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "yes"
        }
      }
    }
  }
}
 

アカウント残高取得コマンド

マルチスレッド対応
APIサンドボックス対応

このコマンドは XML および JSON 形式でのみ利用できます:

アカウント残高取得リクエストパラメータ
説明
N/A追加のパラメータは不要です
結果XMLタグ
説明
<GetAccountBalanceResponse></GetAccountBalanceResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<GetAccountBalanceHeader></GetAccountBalanceHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetAccountBalanceContent></GetAccountBalanceContent>レスポンス内容
<Balance></Balance>アカウント残高

アカウント残高取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_account_balance
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_account_balance
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetAccountBalanceResponse>
  <GetAccountBalanceHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAccountBalanceHeader>
  <GetAccountBalanceContent>
    <BalanceList>
      <Balance>
        <Currency>USD</Currency>
        <Amount>300.00</Amount>
      </Balance>
    </BalanceList>
  </GetAccountBalanceContent>
</GetAccountBalanceResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_account_balance
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_account_balance
応答 (JSON形式)
{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}
 

デフォルト Whois を設定

マルチスレッド対応
APIサンドボックス対応

set default Whoisコマンドを呼び出す場合, 以下のパラメータを含める必要があります:

デフォルトのWhoisリクエストパラメータを設定
説明
registrant_contactドメインの登録者情報
admin_contactドメインの管理者情報
technical_contactドメインの技術情報
billing_contactドメインの請求情報
結果XMLタグ
説明
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>レスポンスXMLドキュメントのルートノード
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

デフォルトWhois設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
応答 (XML形式)
<SetDefaultWhoisResponse>
   <SetDefaultWhoisHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultWhoisHeader>
</SetDefaultWhoisResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
応答 (JSON形式)
{
   "SetDefaultWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

デフォルトネームサーバー設定コマンド

マルチスレッド対応
APIサンドボックス対応

デフォルトネームサーバー設定コマンドを呼び出す場合、以下のパラメータを含める必要があります:

デフォルトネームサーバー設定リクエストパラメータ
説明
ns0 - ns12設定したいネームサーバー
結果XMLタグ
説明
<SetDefaultNsResponse></SetDefaultNsResponse>set default name servers レスポンスのタグ, それはレスポンスXMLドキュメントのルートノードです
<SetDefaultNsHeader></SetDefaultNsHeader>デフォルトネームサーバー設定ヘッダーのタグ
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<SetDefaultNsContent></SetDefaultNsContent>デフォルトネームサーバー設定コンテンツのタグ。ステータスが "success" の場合にのみ使用されます
<Servers></Servers>設定したサーバーの情報
<Server></Server>各サーバー
<ServerName></ServerName>サーバー名
<ServerId></ServerId>サーバー ID

デフォルトNS設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultNsResponse>
  <SetDefaultNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultNsHeader>
  <SetDefaultNsContent>
    <Servers>
      <Server>
        <ServerName>ns1.hosts.com</ServerName>
        <ServerId>0</ServerId>
      </Server>
      <Server>
        <ServerName>ns2.hosts.com</ServerName>
        <ServerId>1</ServerId>
      </Server>
    </Servers>
  </SetDefaultNsContent>
</SetDefaultNsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
応答 (JSON形式)
{
  "SetDefaultNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetDefaultNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

デフォルトパーキング設定コマンド

マルチスレッド対応
APIサンドボックス対応

デフォルトパーキング設定コマンドを呼び出す場合、以下のパラメータを含める必要があります:

デフォルトのパーキングリクエストパラメータを設定
説明
with_ads (optional)サードパーティ広告を表示したくない場合は、このパラメータに"no"を指定できます。デフォルト値は"yes"です
結果XMLタグ
説明
<SetDefaultParkingResponse></SetDefaultParkingResponse>レスポンスXMLドキュメントのルートノード
<SetDefaultParkingHeader></SetDefaultParkingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

デフォルトパーキング設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_parking&folder_id=0&with_ads=no
応答 (XML形式)
<SetDefaultParkingResponse>
   <SetDefaultParkingHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultParkingHeader>
</SetDefaultParkingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_parking&folder_id=0&with_ads=no
応答 (JSON形式)
{
   "SetDefaultParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

デフォルト転送設定コマンド

マルチスレッド対応
APIサンドボックス対応

デフォルト転送設定コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

デフォルト転送設定リクエストパラメータ
説明
forward_urlドメインの転送先にしたいURLです。パラメータは必ず~でなければならない点に注意してください エンコード済み API呼び出しが適切に解釈されるように.
is_temp (optional)設定したいドメインの転送ステータス。デフォルト値は "temporary" です。永続的に転送したい場合は、このパラメータに "no" を指定してください
結果XMLタグ
説明
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>レスポンスXMLドキュメントのルートノード
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

デフォルト転送設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
応答 (XML形式)
<SetDefaultForwardingResponse>
  <SetDefaultForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
応答 (JSON形式)
{
   "SetDefaultForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

デフォルトのステルス コマンドを設定

マルチスレッド対応
APIサンドボックス対応

デフォルトステルス設定コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

デフォルトのステルスリクエストパラメータを設定
説明
stealth_urlドメインの転送先にしたいURLです。パラメータは必ず~でなければならない点に注意してください エンコード済み API呼び出しが適切に解釈されるように.
stealth_title (optional)ページのタイトル
結果XMLタグ
説明
<SetDefaultStealthResponse></SetDefaultStealthResponse>レスポンスXMLドキュメントのルートノード
<SetDefaultStealthHeader></SetDefaultStealthHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

デフォルトステルスの設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
応答 (XML形式)
<SetDefaultStealthResponse>
  <SetDefaultStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultStealthHeader>
</SetDefaultStealthResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
応答 (JSON形式)
{
   "SetDefaultStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

デフォルトホスティング設定コマンド

マルチスレッド対応
APIサンドボックス対応

set default hosting コマンドを呼び出す場合, 以下のパラメータを含める必要があります:

デフォルトホスティング設定リクエストパラメータ
説明
hosting_type希望するデフォルトホスティングのタイプ。"advanced"または"basic"から選択できます
結果XMLタグ
説明
<SetDefaultHostingResponse></SetDefaultHostingResponse>レスポンスXMLドキュメントのルートノード
<SetDefaultHostingHeader></SetDefaultHostingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

デフォルトホスティング設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_hosting&hosting_type=advanced
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_hosting&hosting_type=advanced
応答 (XML形式)
<SetDefaultHostingResponse>
  <SetDefaultHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultHostingHeader>
</SetDefaultHostingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_hosting&hosting_type=advanced
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_hosting&hosting_type=advanced
応答 (JSON形式)
{
   "SetDefaultHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

デフォルトDNS設定コマンド

マルチスレッド対応
APIサンドボックス対応

set default DNS コマンドを呼び出す場合, 次のパラメータを含める必要があります:

( このコマンドは時代遅れで推奨されません。代わりに Set Default DNS2 Command を使用してください )

デフォルトDNSリクエストパラメータを設定
説明
main_record_typeメインレコードタイプ
main_recordドメインのDNSレコードを指定してください
main_txt (optional)ドメインのTXTレコードを指定します。main_record_typeがaaaaで、main_record2を指定した場合、最大3つのmain_txtsを設定できます。それ以外の場合は、最大4つのmain_txtsを設定できます。
main_record2メインレコード2, "main_record_type" が "aaaa" の場合にのみ使用されます. その値は ipv4 形式である必要があります.
subdomain0 - subdomain99 (optional)サブドメインレコード
sub_record_type0 - sub_record_type99 (optional)サブドメインレコードのタイプ
sub_record0 - sub_record99 (optional)IPアドレスまたはターゲットホスト
mx_host0 - mx_host2 (optional)ドメインのメールホストを指定します, distance0 が最も優先度が高いです.
mx_distance0 - mx_distance2 (optional)Distance0 が最優先です
ttl (optional)生存時間
結果XMLタグ
説明
<SetDefaultDnsResponse></SetDefaultDnsResponse>レスポンスXMLドキュメントのルートノード
<SetDefaultDnsHeader></SetDefaultDnsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

デフォルトDNS設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
応答 (XML形式)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
応答 (JSON形式)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

デフォルトDNS2設定コマンド

マルチスレッド対応
APIサンドボックス対応

set default DNS コマンドを呼び出す場合, 次のパラメータを含める必要があります:

デフォルトDNS2設定リクエストパラメータ
説明
main_record_type0 - main_record_type19メインレコードタイプ
main_record0 - main_record19ドメインのDNSレコードを指定します
main_recordx0 - main_recordx19MX距離、転送タイプ、ステルス転送タイトル、またはメールエイリアス。main_record が "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email" の場合に必要です。
subdomain0 - subdomain99 (optional)サブドメインレコード
sub_record_type0 - sub_record_type99 (optional)サブドメインレコードのタイプ
sub_record0 - sub_record99 (optional)サブドメインのIPアドレスまたはターゲットホスト
sub_recordx0 - subdo_recordx99Mx距離、転送タイプ、ステルス転送タイトル、またはメールエイリアス。sub_record_type が "a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"email" の場合に必要です
ttl (optional)生存時間
結果XMLタグ
説明
<SetDefaultDnsResponse></SetDefaultDnsResponse>レスポンスXMLドキュメントのルートノード
<SetDefaultDnsHeader></SetDefaultDnsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

デフォルトDNS2の設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
応答 (XML形式)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
応答 (JSON形式)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

デフォルトメール転送設定コマンド

マルチスレッド対応
APIサンドボックス対応

set default email forward コマンドを呼び出す場合は, 次のパラメータを含める必要があります:

デフォルトメール転送設定リクエストパラメータ
説明
forward_type転送タイプ。"donot": メールを転送しない、"mx": メールを別のメールホストに配信(MXレコード)、"forward": メールを別のメールホストに配信
username0 - username9ユーザー名, "forward_type" が "forward" の場合にのみ使用されます
exist_email0 - exist_email9既存のメールアドレス。"forward_type" が "forward" の場合にのみ使用されます
mx_host0 - mx_host2メールホスト。"forward_type" が "mx" の場合にのみ使用されます。
mx_distance0 - mx_distance2Distance0は最高優先度で、"forward_type" が "mx" の場合にのみ使用されます。
結果XMLタグ
説明
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>レスポンスXMLドキュメントのルートノード
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

デフォルトのメール転送設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
応答 (XML形式)
<SetDefaultEmailForwardingResponse>
  <SetDefaultEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
応答 (JSON形式)
{
   "SetDefaultEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

デフォルト設定をクリアする設定コマンド

マルチスレッド対応
APIサンドボックス対応

set clear default setting コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

デフォルト設定クリアリクエストパラメータを設定
説明
serviceクリアしたいサービス。"forward"、"stealth"、"email_forwarding"、"dns"、"nameservers" のいずれかです。
結果XMLタグ
説明
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>レスポンスXMLドキュメントのルートノード
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

デフォルト設定クリアの設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_default_setting&service=nameservers
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_default_setting&service=nameservers
応答 (XML形式)
<SetClearDefaultSettingResponse>
  <SetClearDefaultSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_default_setting&service=nameservers
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_default_setting&service=nameservers
応答 (JSON形式)
{
   "SetClearDefaultSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

デフォルトの更新オプションを設定するコマンド

マルチスレッド対応
APIサンドボックス対応

デフォルトの更新オプション設定コマンドを呼び出す場合は、次のパラメータを含める必要があります:

デフォルト更新オプション設定リクエストパラメータ
説明
renew_option"donot"、"auto"、"reset" のいずれかになります。
結果XMLタグ
説明
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>レスポンスXMLドキュメントのルートノード
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

デフォルト更新オプション設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_renew_option&renew_option=auto
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_renew_option&renew_option=auto
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultRenewOptionResponse>
  <SetDefaultRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_renew_option&renew_option=auto
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_renew_option&renew_option=auto
応答 (JSON形式)
{
  "SetDefaultRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

フォルダ作成コマンド

マルチスレッド対応
APIサンドボックス対応

create folder コマンドを呼び出す場合, 以下のパラメータを含める必要があります:

フォルダ作成リクエストパラメータ
説明
folder_name作成するフォルダの名前
結果XMLタグ
説明
<FolderCreateResponse></FolderCreateResponse>レスポンスXMLドキュメントのルートノード
<FolderCreateHeader></FolderCreateHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<FolderCreateContent></FolderCreateContent>レスポンス内容
<FolderName></FolderName>フォルダ名
<FolderId></FolderId>新しいフォルダのID

フォルダ作成の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=create_folder&folder_name=new
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=create_folder&folder_name=new
応答 (XML形式)
<FolderCreateResponse>
  <FolderCreateHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </FolderCreateHeader>
  <FolderCreateContent>
    <FolderName>new</FolderName>
    <FolderId>1</FolderId>
  </FolderCreateContent>
</FolderCreateResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=create_folder&folder_name=new
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=create_folder&folder_name=new
応答 (JSON形式)
{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}
 

フォルダ削除コマンド

マルチスレッド対応
APIサンドボックス対応

set Whoisコマンドを呼び出す場合、以下のパラメータを含める必要があります:

フォルダ削除リクエストパラメータ
説明
folder_id削除するフォルダのIDです。カンマで区切られていることを確認してください
結果XMLタグ
説明
<DeleteFolderResponse></DeleteFolderResponse>レスポンスXMLドキュメントのルートノード
<DeleteFolderHeader></DeleteFolderHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

フォルダ削除の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_folder&folder_id=0,1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_folder&folder_id=0,1
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteFolderResponse>
  <DeleteFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteFolderHeader>
</DeleteFolderResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_folder&folder_id=0,1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_folder&folder_id=0,1
応答 (JSON形式)
{
  "DeleteFolderResponse": {
    "SuccessCode": 0,
    "Status": "success"
  }
}
 

フォルダWhois設定コマンド

マルチスレッド対応
APIサンドボックス対応

set folder Whoisコマンドを呼び出す場合, 以下のパラメータを含める必要があります:

フォルダWhoisリクエストパラメータ設定
説明
folder_id設定するフォルダのID
registrant_contactドメインの登録者情報
admin_contactドメインの管理者情報
technical_contactドメインの技術情報
billing_contactドメインの請求情報
enable (optional)この Whois 設定を、このフォルダに移動する将来のドメインに適用したい場合は、このパラメータを "yes" で使用できます
sync (optional)このフォルダ内のすべてのドメインのWhois設定を同期したい場合は、このパラメータを "yes" で使用できます。
結果XMLタグ
説明
<SetFolderWhoisResponse></SetFolderWhoisResponse>レスポンスXMLドキュメントのルートノード
<SetFolderWhoisHeader></SetFolderWhoisHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

Set Folder Whois の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
応答 (XML形式)
<SetFolderWhoisResponse>
  <SetFolderWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderWhoisHeader>
</SetFolderWhoisResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
応答 (JSON形式)
{
   "SetFolderWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

フォルダのネームサーバー設定コマンド

マルチスレッド対応
APIサンドボックス対応

set folder name servers コマンドを呼び出す場合, 以下のパラメータを含める必要があります:

フォルダ名ネームサーバー設定リクエストパラメータ
説明
fold_id設定したいフォルダのID。1回のリクエストにつき1つのフォルダのみ設定できます
ns0 - ns12ドメインで使用するネームサーバーを設定します。最大13台のネームサーバーを指定できますが、それらはすでにアカウント内に存在している必要があります
enable (optional)このネームサーバー設定を、このフォルダに移動する今後のドメインにも適用したい場合は、このパラメータを "yes" で使用できます
sync (optional)このフォルダ内のすべてのドメインのネームサーバー設定を同期したい場合は、このパラメータに "yes" を指定できます。
結果XMLタグ
説明
<SetFolderNsResponse></SetFolderNsResponse>フォルダ名設定サーバー応答のタグ。応答 XML ドキュメントのルートノードです
<SetFolderNsHeader></SetFolderNsHeader>設定フォルダのネームサーバー応答ヘッダーのタグ
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<SetFolderNsContent></SetFolderNsContent>設定フォルダのネームサーバー応答内容のタグ。ステータスが "success" の場合にのみ使用されます
<Servers></Servers>設定したサーバーの情報
<Server></Server>各サーバー
<ServerName></ServerName>サーバー名
<ServerId></ServerId>サーバーID

フォルダNS設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetFolderNsResponse>
  <SetFolderNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNsHeader>
  <SetFolderNsContent>
    <Servers>
      <Server>
        <ServerName>ns1.hosts.com</ServerName>
        <ServerId>0</ServerId>
      </Server>
      <Server>
        <ServerName>ns2.hosts.com</ServerName>
        <ServerId>1</ServerId>
      </Server>
    </Servers>
  </SetFolderNsContent>
</SetFolderNsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
応答 (JSON形式)
{
  "SetFolderNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetFolderNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

フォルダパーキング設定コマンド

マルチスレッド対応
APIサンドボックス対応

set folder parking コマンドを呼び出す場合, 次のパラメータを含める必要があります:

フォルダパーキング設定リクエストのパラメータ
説明
folder_id設定したいフォルダのID。1回のリクエストにつき1つのフォルダのみ設定できます
with_ads (optional)サードパーティ広告を表示したくない場合は、このパラメータに"no"を指定できます。デフォルト値は"yes"です
enable (optional)このパーキング設定を、このフォルダに移動する将来のドメインに適用したい場合は、このパラメータを "yes" で使用できます
sync (optional)このフォルダ内のすべてのドメインのパーキング設定を同期したい場合は、このパラメータに"yes"を指定できます
結果XMLタグ
説明
<SetFolderParkingResponse></SetFolderParkingResponse>レスポンスXMLドキュメントのルートノード
<SetFolderParkingHeader></SetFolderParkingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

フォルダパーキング設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_parking&folder_id=0&with_ads=no
応答 (XML形式)
<SetFolderParkingResponse>
  <SetFolderParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderParkingHeader>
</SetFolderParkingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_parking&folder_id=0&with_ads=no
応答 (JSON形式)
{
   "SetFolderParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

フォルダ転送設定コマンド

マルチスレッド対応
APIサンドボックス対応

フォルダ転送設定コマンドを呼び出す場合, 次のパラメータを含める必要があります:

フォルダ転送リクエストパラメータの設定
説明
folder_id設定するフォルダのID
forward_urlドメインの転送先にしたいURLです。パラメータは必ず~でなければならない点に注意してください エンコード済み API呼び出しが適切に解釈されるように.
is_temp (optional)設定したいドメインの転送ステータス。デフォルト値は "temporary" です。永続的に転送したい場合は、このパラメータに "no" を指定してください
enable (optional)この転送設定を、今後このフォルダに移動するドメインにも適用したい場合は、このパラメータを "yes" と一緒に使用できます。
sync (optional)このフォルダー内のすべてのドメインの転送設定を同期したい場合は、このパラメータに "yes" を指定して使用できます
結果XMLタグ
説明
<SetFolderForwardingResponse></SetFolderForwardingResponse>レスポンスXMLドキュメントのルートノード
<SetFolderForwardingHeader></SetFolderForwardingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

フォルダ転送設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
応答 (XML形式)
<SetFolderForwardingResponse>
  <SetFolderForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderForwardingHeader>
</SetFolderForwardingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
応答 (JSON形式)
{
   "SetFolderForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

フォルダステルス設定コマンド

マルチスレッド対応
APIサンドボックス対応

フォルダステルス設定コマンドを呼び出す場合, 以下のパラメータを含める必要があります:

フォルダステルスリクエストパラメータの設定
説明
folder_id設定するフォルダのID
stealth_urlドメインの転送先にしたいURLです。パラメータは必ず~でなければならない点に注意してください エンコード済み API呼び出しが適切に解釈されるように.
stealth_title (optional)ページのタイトル
enable (optional)このステルス設定を、今後このフォルダに移動するドメインにも適用したい場合は、このパラメータに "yes" を指定できます。
sync (optional)このフォルダ内のすべてのドメインのステルス設定を同期したい場合は、このパラメータを "yes" で使用できます
結果XMLタグ
説明
<SetFolderStealthResponse></SetFolderStealthResponse>レスポンスXMLドキュメントのルートノード
<SetFolderStealthHeader></SetFolderStealthHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

Set Folder Stealth設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
応答 (XML形式)
<SetFolderStealthResponse>
  <SetFolderStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderStealthHeader>
</SetFolderStealthResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
応答 (JSON形式)
{
   "SetFolderStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

フォルダホスティング設定コマンド

マルチスレッド対応
APIサンドボックス対応

set folder hosting コマンドを呼び出す場合は、次のパラメータを含める必要があります:

フォルダホスティングリクエストパラメータを設定する
説明
folder_id設定するフォルダのID
hosting_type希望するホスティングの種類。"advanced" と "basic" から選択できます。
enable (optional)このホスティング設定を、今後このフォルダに移動するドメインにも適用したい場合は、このパラメータに "yes" を指定できます。
even (optional)このフォルダ内のすべてのドメインのホスティング設定を同期したい場合は、このパラメータを "yes" と一緒に使用できます。
結果XMLタグ
説明
<SetFolderHostingResponse></SetFolderHostingResponse>レスポンスXMLドキュメントのルートノード
<SetFolderHostingHeader></SetFolderHostingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

フォルダホスティング設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
応答 (XML形式)
<SetFolderHostingResponse>
  <SetFolderHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHostingHeader>
</SetFolderHostingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
応答 (JSON形式)
{
   "SetFolderHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

フォルダDNS設定コマンド

マルチスレッド対応
APIサンドボックス対応

フォルダDNS設定コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

(このコマンドは古く、推奨されていません。代わりに Set Folder DNS2 コマンドを使用してください)

フォルダDNS設定リクエストパラメータ
説明
folder_id設定したいフォルダのID
main_record_typeメインレコードタイプ
main_recordドメインのDNSレコードを指定してください
main_recordドメインのDNSレコードを指定してください
with_ads (optional)ドメインのTXTレコードを指定します。main_record_typeがaaaaで、main_record2を指定した場合、最大3つのmain_txtsを設定できます。それ以外の場合は、最大4つのmain_txtsを設定できます。
main_record2メインレコード2, "main_record_type" が "aaaa" の場合にのみ使用されます. その値は ipv4 形式である必要があります.
subdomain0 - subdomain99 (optional)サブドメインレコード (オプション)
sub_record_type0 - sub_record_type99 (optional)サブドメインレコードのタイプ
sub_record0 - sub_record99 (optional)IPアドレスまたはターゲットホスト
mx_host0 - mx_host2 (optional)ドメインのメールホストを指定します, distance0 が最も優先度が高いです.
mx_distance0 - mx_distance2 (optional)Distance0が最優先です
ttl (optional)生存時間
enable (optional)この DNS 設定を、このフォルダに移動する今後のドメインに適用したい場合は、このパラメータを "yes" で使用できます
sync (optional)このフォルダ内のすべてのドメインでこのDNSサーバー設定を同期したい場合は、このパラメータに"yes"を指定できます
結果XMLタグ
説明
<SetFolderDnsResponse></SetFolderDnsResponse>レスポンスXMLドキュメントのルートノード
<SetFolderDnsHeader></SetFolderDnsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

フォルダDNS設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
応答 (XML形式)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
応答 (JSON形式)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

フォルダDNS2コマンドを設定

マルチスレッド対応
APIサンドボックス対応

set folder DNS2コマンドを呼び出す場合, 以下のパラメータを含める必要があります:

フォルダDNS2リクエストパラメータ設定
説明
folder_id設定したいフォルダのID
main_record_type0 - main_record_type19メインレコードタイプ。"a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email" のいずれかである必要があります。
main_record0 - main_record19ドメインのDNSレコードを指定します
main_recordx0 - main_recordx19MX距離、転送タイプ、ステルス転送のタイトルまたはメールエイリアス。main_record_type が "forward","mx","stealth","email" の場合に必要です
subdomain0 - subdomain99 (optional)サブドメインレコード (オプション)
sub_record_type0 - sub_record_type99 (optional)サブドメインレコードのタイプ。"a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"email" のいずれかである必要があります
sub_record0 - sub_record99 (optional)IPアドレスまたはターゲットホスト
sub_recordx0 - sub_recordx99 (optional)MX距離、転送タイプ、ステルス転送タイトル、またはメールエイリアス。sub_record_type が "forward","mx","stealth","email" の場合に必要です。
ttl (optional)生存時間
enable (optional)この DNS 設定を、このフォルダに移動する今後のドメインに適用したい場合は、このパラメータを "yes" で使用できます
sync (optional)このフォルダ内のすべてのドメインでこのDNSサーバー設定を同期したい場合は、このパラメータに"yes"を指定できます
結果XMLタグ
説明
<SetFolderDnsResponse></SetFolderDnsResponse>レスポンスXMLドキュメントのルートノード
<SetFolderDnsHeader></SetFolderDnsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

フォルダDns2の例を設定

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
応答 (JSON形式)
{
  "SetFolderDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Set Folder Email Forward コマンド

マルチスレッド対応
APIサンドボックス対応

set folder email forward コマンドを呼び出す場合, 以下のパラメータを含める必要があります:

フォルダメール転送設定リクエストパラメータ
説明
domain設定したいドメイン名, 1リクエストにつき100ドメインまで設定できます, カンマで区切られていることを確認してください
folder_id設定するフォルダのID
forward_type転送タイプ。"donot": メールを転送しない、"mx": メールを別のメールホストに配信(MXレコード)、"forward": メールを別のメールホストに配信
username0 - username9ユーザー名, "forward_type" が "forward" の場合にのみ使用されます
exist_email0 - exist_email9既存のメールアドレス。"forward_type" が "forward" の場合にのみ使用されます
mx_host0 - mx_host2メールホスト。"forward_type" が "mx" の場合にのみ使用されます。
mx_distance0 - mx_distance2Distance0は最高優先度で、"forward_type" が "mx" の場合にのみ使用されます。
enable (optional)この設定を、今後このフォルダに移動するドメインにも適用したい場合は、このパラメータに "yes" を指定できます。
sync (optional)このフォルダ内のすべてのドメインでこの設定を同期したい場合は、このパラメータを "yes" と一緒に使用できます。
結果XMLタグ
説明
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>レスポンスXMLドキュメントのルートノード
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

フォルダメール転送設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
応答 (XML形式)
<SetFolderEmailForwardingResponse>
  <SetFolderEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
応答 (JSON形式)
{
   "SetFolderEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

クリアフォルダ設定コマンド

マルチスレッド対応
APIサンドボックス対応

set clear folder setting コマンドを呼び出す場合は、以下のパラメータを含める必要があります:

フォルダ設定クリアのリクエストパラメータの設定
説明
folder_id設定するフォルダのID
serviceクリアしたいサービス。"forward"、"stealth"、"email_forwarding"、"dns"、"nameservers" のいずれかです。
結果XMLタグ
説明
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>レスポンスXMLドキュメントのルートノード
<SetClearFolderSettingHeader></SetClearFolderSettingHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

フォルダ設定をクリアする例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
応答 (XML形式)
<SetClearFolderSettingResponse>
  <SetClearFolderSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
応答 (JSON形式)
{
   "SetClearFolderSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

フォルダ名設定コマンド

マルチスレッド対応
APIサンドボックス対応

set folder name コマンドを呼び出す場合は, 以下のパラメータを含める必要があります:

フォルダ名設定リクエストパラメータ
説明
folder_id設定したいフォルダのID
folder_name新しいフォルダ名
結果XMLタグ
説明
<SetFolderNameResponse></SetFolderNameResponse>レスポンスXMLドキュメントのルートノード
<SetFolderNameHeader></SetFolderNameHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

フォルダ名設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_name&folder_id=0&folder_name=new
応答 (XML形式)
<SetFolderNameResponse>
  <SetFolderNameHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNameHeader>
</SetFolderNameResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_name&folder_id=0&folder_name=new
応答 (JSON形式)
{
   "SetFolderNameResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

フォルダ更新オプション設定コマンド

マルチスレッド対応
APIサンドボックス対応

フォルダ更新オプション設定コマンドを呼び出す場合は、次のパラメータを含める必要があります:

フォルダ更新オプション設定リクエストパラメータ
説明
folder_id設定したいフォルダのID。1回のリクエストにつき1つのフォルダのみ設定できます
renew_optionフォルダに設定したい更新オプション。"donot"、"auto"、"reset" のいずれかです。
enable (optional)この更新設定を、今後このフォルダに移動するドメインにも適用したい場合は、このパラメータに "yes" を指定できます。
sync (optional)このフォルダ内のすべてのドメインの更新設定を同期したい場合は、このパラメータを "yes" で使用できます。
結果XMLタグ
説明
<Response></Response>レスポンスXMLドキュメントのルートノード
<ResponseHeader></ResponseHeader>ResponseHeader
<ResponseCode></ResponseCode>レスポンスコード、成功の場合は "0"、失敗の場合は "-1"
<Error></Error>エラー情報。レスポンスコードが "-1" の場合にのみ使用されます。

フォルダ更新オプションの設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
応答 (XML形式)
<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
応答 (JSON形式)
{
   "SetFolderRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

フォルダ一覧コマンド

マルチスレッド対応
APIサンドボックス対応

このコマンドは XML および JSON 形式でのみ利用できます:

フォルダリストリクエストパラメータ
説明
N/A追加のパラメータは不要です
<FolderListResponse></FolderListResponse>レスポンスXMLドキュメントのルートノード
<FolderListHeader></FolderListHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<FolderListContent></FolderListContent>レスポンス内容
<FolderList></FolderList>フォルダリスト
<List></List>
<Folder></Folder>
<FolderId></FolderId>フォルダID
<FolderName></FolderName>フォルダ名
<DefaultWhois></DefaultWhois>デフォルトのWhois
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>Whoisのデフォルト有効ステータス
<DefaultRegistrant></DefaultRegistrant>デフォルト登録者
<ContactId></ContactId>連絡先のID
<DefaultAdmin></DefaultAdmin>デフォルト管理者
<DefaultTechnical></DefaultTechnical>デフォルトの技術情報
<DefaultBilling></DefaultBilling>デフォルトの請求情報
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>デフォルトネームサーバーの有効状態
<NameServerSettings></NameServerSettings>ネームサーバー設定
<Type></Type>ネームサーバータイプ
<WithAds></WithAds>広告の有無
<DefaultRenewOption></DefaultRenewOption>デフォルトの更新オプション
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>デフォルト更新オプションの有効ステータス
<RenewOption></RenewOption>更新オプション
<DefaultTransferLock></DefaultTransferLock>デフォルトの移管ロック
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>デフォルトの転送ロック有効ステータス
<LockStatus></LockStatus>ロック状態

フォルダ一覧の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=folder_list
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=folder_list
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<FolderListResponse>
  <FolderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </FolderListHeader>
  <FolderListContent>
    <FolderList>
      <List>
        <Folder>
          <FolderId>0</FolderId>
          <FolderName>new</FolderName>
          <DefaultWhois>
            <DefaultWhoisEnableStatus>disable</DefaultWhoisEnableStatus>
            <DefaultRegistrant>
              <ContactId>0</ContactId>
            </DefaultRegistrant>
            <DefaultAdmin>
              <ContactId>0</ContactId>
            </DefaultAdmin>
            <DefaultTechnical>
              <ContactId>0</ContactId>
            </DefaultTechnical>
            <DefaultBilling>
              <ContactId>0</ContactId>
            </DefaultBilling>
          </DefaultWhois>
          <DefaultNameServers>
            <DefaultNameServerEnableStatus>disable</DefaultNameServerEnableStatus>
            <NameServerSettings>
              <Type>Dynadot Parking</Type>
              <WithAds>Yes</WithAds>
            </NameServerSettings>
          </DefaultNameServers>
          <DefaultRenewOption>
            <DefaultRenewOptionEnableStatus>disable</DefaultRenewOptionEnableStatus>
            <RenewOption>no renew option</RenewOption>
          </DefaultRenewOption>
          <DefaultTransferLock>
            <DefaultTransferLockEnableStatus>disable</DefaultTransferLockEnableStatus>
            <LockStatus>locked</LockStatus>
          </DefaultTransferLock>
        </Folder>
      </List>
    </FolderList>
  </FolderListContent>
</FolderListResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=folder_list
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=folder_list
応答 (JSON形式)
{
  "FolderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "FolderList": [
      {
        "FolderId": "0",
        "FolderName": "new",
        "DefaultWhois": {
          "DefaultWhoisEnableStatus": "disable",
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServers": {
          "DefaultTransferLockEnableStatus": "disable",
          "NameServerSettings": {
            "Type": "Dynadot Parking",
            "WithAds": "Yes"
          }
        },
        "DefaultRenewOption": {
          "DefaultRenewOptionEnableStatus": "disable",
          "RenewOption": "no renew option"
        },
        "DefaultTransferLock": {
          "DefaultTransferLockEnableStatus": "disable",
          "LockStatus": "locked"
        }
      }
    ]
  }
}
 

バックオーダーリクエスト追加コマンド

マルチスレッド対応
API Sandbox はサポートされていません

add backorder requestコマンドを呼び出す場合、以下のパラメータを含める必要があります:

バックオーダーリクエスト追加のリクエストパラメータ
説明
domain追加したいドメイン。Dynadotが取得した場合に支払うことに同意するもの。1リクエストにつき最大100ドメインを追加でき、カンマで区切る必要があります。
結果XMLタグ
説明
<AddBackorderRequestResponse></AddBackorderRequestResponse>レスポンスXMLドキュメントのルートノード
<AddBackorderRequestHeader></AddBackorderRequestHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

バックオーダー追加リクエスト例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
応答 (XML形式)
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
応答 (JSON形式)
{
   "AddBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

バックオーダーリクエスト削除コマンド

マルチスレッド対応
API Sandbox はサポートされていません

delete backorder requestコマンドを呼び出す場合は、次のパラメータを含める必要があります:

バックオーダーリクエストを削除するリクエストパラメータ
説明
domainバックオーダーリクエストリストから削除したいドメイン。1リクエストにつき100ドメインまで削除でき、カンマで区切る必要があります。
結果XMLタグ
説明
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>レスポンスXMLドキュメントのルートノード
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

バックオーダー削除リクエストの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_backorder_request&domain=domaindropp.com
応答 (XML形式)
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_backorder_request&domain=domaindropp.com
応答 (JSON形式)
{
   "DeleteBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

バックオーダーリクエストリストコマンド

マルチスレッド対応
API Sandbox はサポートされていません

バックオーダーリクエストリストコマンドを呼び出すと指定されたアカウントのバックオーダーリクエストリストのリストを返します。このコマンドを呼び出す場合、以下のパラメータを含める必要があります:

バックオーダー申請リストのリクエストパラメータ
説明
start_dateリクエストするオークションのドロップ開始日, yyyy-mm-dd, 例えば 2015-05-05
end_dateリクエストしたいオークションの終了ドロップ日, yyyy-mm-dd, 例 2015-05-05
結果XMLタグ
説明
<BackorderRequestListResponse></BackorderRequestListResponse>レスポンスXMLドキュメントのルートノード
<BackorderRequestListHeader></BackorderRequestListHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<BackorderRequestListContent></BackorderRequestListContent>レスポンス内容
<BackorderRequestList></BackorderRequestList>バックオーダーリクエスト一覧
<BackorderRequest></BackorderRequest>バックオーダーリクエスト
<Domain></Domain>あなたのリストにあるドメイン
<CutoffTime></CutoffTime>リクエストを削除する締切日 (Unix時間, 1970年1月1日午前0時UTCからのミリ秒)
<BackorderRequestStatus></BackorderRequestStatus>ドロップキャッチプロセスにおけるステータス

バックオーダーリクエスト一覧の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<BackorderRequestListResponse>
  <BackorderRequestListHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BackorderRequestListHeader>
  <BackorderRequestListContent>
    <BackorderRequestList>
      <BackorderRequest>
        <DomainName>testdrop.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop3.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop4.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop5.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
    </BackorderRequestList>
  </BackorderRequestListContent>
</BackorderRequestListResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
応答 (JSON形式)
{
  "BackorderRequestListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BackorderRequestList": [
      {
        "DomainName": "testdrop.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop3.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop4.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop5.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      }
    ]
  }
}
リクエスト (CSV形式)https://api.dynadot.com/api3.html?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
サンドボックスリクエスト (CSV形式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
応答 (CSV形式)
ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active
 

オープンオークション取得コマンド

マルチスレッド対応
API Sandbox はサポートされていません

get open auctions コマンドを呼び出すと、進行中のオークションのリストが返されます。このコマンドを呼び出す場合、以下のパラメータを含める必要があります:

オープンオークション取得リクエストパラメータ
説明
currency (optional)返される結果の通貨。"usd"、"eur"、"cny" のいずれかである必要があります。デフォルト通貨は米ドルです
type (optional)表示したいオークションタイプです, "expired", "user", "backorder", または "registry_expired", "registrar", 複数のオークションタイプを取得したい場合は, "," で各オークションタイプを区切ることができます
count_per_page1ページに表示されるエンティティの数 (最大1000)
page_index どのページのエンティティを表示しますか
has_bids (optional)このパラメータが true の場合、入札済みのオークションのみを返します。false の場合は、入札のないオークションを返します。渡されていない場合は、すべてのオークションを返します。
結果XMLタグ
説明
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>get open auctions レスポンスのタグ。これはレスポンスXMLドキュメントのルートノードです
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>オープンオークションのヘッダーを取得
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetOpenAuctionsContent></GetOpenAuctionsContent>Tag of get open auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>オークションのID
<Domain></Domain>オークションのドメイン名
<BidPrice></BidPrice>オークションの現在の入札価格
<BidPriceCurrency></BidPriceCurrency>入札価格の通貨
<Bids></Bids>オークション入札数
<EndTime></EndTime>オークション終了時刻
<EndTimestamp></EndTimestamp>オークションの終了日時(Unix時間、1970年1月1日午前0時UTCからのミリ秒)
<Revenue></Revenue>オークションの収益
<RevenueCurrency></RevenueCurrency>収益の通貨
<Visitors></Visitors>ドメインの訪問者
<Links></Links>ドメインの被リンク
<Age></Age>ドメインの年齢

オープンオークション取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
応答 (XML形式)
<GetOpenAuctionsResponse>
  <GetOpenAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenAuctionsHeader>
  <GetOpenAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    .
    .
    .
  </GetOpenAuctionsContent>
</GetOpenAuctionsResponse>
リクエスト(csv形式)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_auctions¤cy=usd&type=expired&count_per_page=20&page_index=1

応答

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp,Revenue,RevenueCurrency,Visitors,Links,Age
10001,domain.com,92.99,USD,0,2015/04/28 18:04 UTC,1430244248274,0.64,USD,-1,-1,1
10002,xn--wkccg.com,77.99,USD,0,2015/05/01 06:04 UTC,1430460248338,86,USD,435,-1,1
10003,domain2.com,11.25,USD,0,2015/05/05 06:04 UTC,1430805846946,91,USD,358,-1,1
.
.
.

リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
応答 (JSON形式)
{
    "status": "success",
    "auction_list": [
        {
            "auction_id": 11,
            "domain": "domain.com",
            "utf_name": "domain.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "124.00",
            "bids": 4,
            "bidders": 2,
            "time_left": "1 day, 23 hours",
            "start_time": "2022/03/28 02:20 PST",
            "start_time_stamp": 1648459234033,
            "end_time": "2022/04/04 02:20 PST",
            "end_time_stamp": 1649064034033,
            "visitors": 223,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-"
        },
        {
            "auction_id": 12,
            "domain": "domain0.com",
            "utf_name": "domain0.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "44.99",
            "bids": 1,
            "bidders": 1,
            "time_left": "2 days, 23 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "visitors": 245,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-"
        }
        ...
    ]
}
 

オークション詳細取得コマンド

マルチスレッド対応
API Sandbox はサポートされていません

get auction details コマンドを呼び出すと指定されたオークションの詳細が返されます. このコマンドは XML と JSON 形式でのみ利用可能です. このコマンドを呼び出す場合, 以下のパラメータを含める必要があります:

オークション詳細取得リクエストパラメータ
説明
domainオークションのドメイン名。IDN(国際化ドメイン名)は "xn--wkccg.com" のような punycode を使用する必要があります。複数のオークションを取得でき、各ドメインは "," で区切る必要があります
currency (optional)返される結果の通貨。"usd"、"eur"、"cny" のいずれかである必要があります。デフォルト通貨は米ドルです
結果XMLタグ
説明
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>オークション詳細取得レスポンスのタグ。これはレスポンスXMLドキュメントのルートノードです。
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>バックオーダーオークション詳細取得ヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "success"
<AuctionStatusId></AuctionStatusId>オークションのステータスID : '0'は進行中, '1'はユーザーによるキャンセル, '2'は管理者によるキャンセル, '3'は更新によるキャンセル, '4'は完了, '5'は転送によるキャンセル
<AuctionStatus></AuctionStatus>オークションのステータス
<UserIsHighBid></UserIsHighBid>ユーザーが最高入札者の場合
<YourCurrentBid></YourCurrentBid>指定されたオークションの現在の入札価格です。入札していない場合は '-1' になります
<YourProxyBid></YourProxyBid>あなたの プロキシ入札 指定されたオークションの場合. 入札していない場合, '-1'になります
<AuctionId></AuctionId>オークションのID
<Domain></Domain>オークションのドメイン名
<BidPrice></BidPrice>オークションの現在の入札価格
<BidPriceCurrency></BidPriceCurrency>入札価格の通貨
<Bids></Bids>オークション入札数
<EndTime></EndTime>オークション終了時刻
<EndTimestamp></EndTimestamp>オークションの終了日時(Unix時間、1970年1月1日午前0時UTCからのミリ秒)
<IsPremium></IsPremium>プレミアムドメインかどうか
<RenewalPrice></RenewalPrice>更新価格

オークション詳細取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
サンドボックスリクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetAuctionDetailsResponse>
  <GetAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAuctionDetailsHeader>
  <GetAuctionDetailsContent>
    <Auction>
      <AuctionStatusId>0</AuctionStatusId>
      <AuctionStatus>1</AuctionStatus>
      <AuctionId>0</AuctionId>
      <Domain>test.biz</Domain>
      <BidPrice>46.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>1970/01/01 00:00 UTC</EndTime>
      <EndTimestamp>0</EndTimestamp>
      <Revenue>1</Revenue>
      <RevenueCurrency>USD</RevenueCurrency>
      <Visitors>-1</Visitors>
      <Links>1</Links>
      <Age>10</Age>
      <isPremium>false</isPremium>
      <RenewalPrice>-0.1</RenewalPrice>
      <UserIsHighBid>false</UserIsHighBid>
      <YourCurrentBid>-1</YourCurrentBid>
      <YourProxyBid>-1</YourProxyBid>
    </Auction>
  </GetAuctionDetailsContent>
</GetAuctionDetailsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
サンドボックスリクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
応答 (JSON形式)
{
  "status": "success",
  "size": 1,
  "auction_details": [
    {
      "auction_json": {
        "auction_id": 0,
        "domain": "test.biz",
        "utf_name": "test.biz",
        "is_idn": false,
        "auction_type": "expired",
        "current_bid_price": "46.99",
        "accepted_bid_price": "46.99",
        "currency": "USD",
        "is_high_bidder": false,
        "bids": 0,
        "bidders": 0,
        "auction_status_id": 0,
        "time_left": "1",
        "start_time": "1",
        "start_time_stamp": 0,
        "end_time": "",
        "end_time_stamp": 0,
        "revenue": "1",
        "visitors": -1,
        "links": "1",
        "age": 10,
        "estibot_appraisal": "",
        "dyna_appraisal": "",
        "bidder_name": "",
        "bid_price": "",
        "timestamp": 0,
        "bid_status": "",
        "is_proxy_auto_bid": false,
        "auction_ended": false,
        "customer_bided": false,
        "customer_bid": "1",
        "customer_proxy_bid": "1",
        "is_premium": false,
        "renewal_price": "-0.1"
      },
      "bid_history": []
    }
  ]
}
 

オークション入札取得コマンド

マルチスレッド対応
API Sandbox はサポートされていません

get auction bids コマンドを呼び出すと、あなたが参加した入札リストを取得できます。このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

オークション入札取得リクエストパラメータ
説明
currency (optional)入札の通貨。"usd"、"eur"、または "cny" である必要があります。デフォルトの通貨は米ドルです。
count_per_page1ページあたりに表示されるエンティティの数(最大50)
page_index どのページのエンティティを表示しますか
結果XMLタグ
説明
<GetAuctionBidsResponse></GetAuctionBidsResponse>get auction bids レスポンスのタグ, これはレスポンス XML ドキュメントのルートノードです
<GetAuctionBidsHeader></GetAuctionBidsHeader>オークション入札ヘッダー取得
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetAuctionBidsContent></GetAuctionBidsContent>Tag of get auction bids content, it's only used when status is "success"
<BidList></BidList> 入札リスト
<Bid></Bid> 入札項目
<BidId></BidId> 入札のID
<AuctionId></AuctionId> オークションのID
<AccountId></AccountId>アカウントのID
<Domain></Domain>オークションのドメイン名
<DomainUtf></DomainUtf>オークションのドメイン UTF 名
<AuctionType></AuctionType>オークションの種類
<IsIdn></IsIdn>このドメインが国際化ドメイン名の場合
<CurrentBid></CurrentBid>オークションの現在の入札価格
<YourStatus></YourStatus>オークションの入札ステータス
<ProxyBid></ProxyBid>このオークションへのあなたの代理入札価格
<ActiveBidders></ActiveBidders>このオークションに参加している入札者の数
<TimeLeft></TimeLeft>オークションの残り時間
<EndTime></EndTime>オークションの終了時刻
<EndTimestamp></EndTimestamp>オークションの終了タイムスタンプ

オークション入札取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
応答 (XML形式)
<GetAuctionBidsResponse>
    <GetAuctionBidsHeader>
        <SuccessCode>0</SuccessCode>
        <Status>success</Status>
    </GetAuctionBidsHeader>
    <GetAuctionBidsContent>
        <BidList>
            <Bid>
                <BidId>0</BidId>
                <AuctionId>11</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain.com</Domain>
                <DomainUtf>domain.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$124.00</CurrentBid>
                <YourStatus>Out Bid</YourStatus>
                <ProxyBid>$119.00</ProxyBid>
                <ActiveBidders>2</ActiveBidders>
                <TimeLeft>1 day, 6 hours</TimeLeft>
                <EndTime>2022/04/04 02:20:34 PST</EndTime>
                <EndTimestamp>1649064034033</EndTimestamp>
            </Bid>
            <Bid>
                <BidId>9</BidId>
                <AuctionId>12</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain0.com</Domain>
                <DomainUtf>domain0.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$44.99</CurrentBid>
                <YourStatus>High Bidder</YourStatus>
                <ProxyBid>$121.00</ProxyBid>
                <ActiveBidders>1</ActiveBidders>
                <TimeLeft>2 days, 6 hours</TimeLeft>
                <EndTime>2022/04/05 02:20:34 PST</EndTime>
                <EndTimestamp>1649150434049</EndTimestamp>
            </Bid>
        </BidList>
    </GetAuctionBidsContent>
</GetAuctionBidsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
応答 (JSON形式)
{
    "status": "success",
    "auction_bids": [
        {
            "bid_id": 0,
            "auction_id": 11,
            "account_id": "1",
            "domain": "domain.com",
            "domain_utf": "domain.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "1 day, 23 hours",
            "end_time": "2022/04/04 02:20:34 PST",
            "end_time_stamp": 1649064034033
        },
        {
            "bid_id": 2,
            "auction_id": 12,
            "account_id": "1",
            "domain": "domain0.com",
            "domain_utf": "domain0.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "2 days, 23 hours",
            "end_time": "2022/04/05 02:20:34 PST",
            "end_time_stamp": 1649150434049
        }
        ...
    ]
}
 

オークション入札コマンド

マルチスレッド対応
API Sandbox はサポートされていません

オークション入札コマンドを呼び出すと, 指定されたオークションに入札します. このコマンドを呼び出す場合, 以下のパラメータを含める必要があります:

オークション入札リクエストパラメータ
説明
domainオークションのドメイン名。IDN(国際化ドメイン名)は punycode を使用してください。例:"xn--wkccg.com"
bid_amountオークションへの入札金額。デフォルトの通貨は米ドルですが、以下のcurrencyパラメータで指定することもできます。
currency (optional)入札の通貨。"usd"、"eur"、または "cny" である必要があります。デフォルトの通貨は米ドルです。
結果XMLタグ
説明
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>オークション入札レスポンスのタグで、レスポンスXMLドキュメントのルートノードです
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>オークション入札のヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

ドメインの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
応答 (XML形式)
<PlaceAuctionBidResponse>
  <PlaceAuctionBidHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </PlaceAuctionBidHeader>
</PlaceAuctionBidResponse>
リクエスト(csv形式)

https://api.dynadot.com/api3.html?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9¤cy=usd

応答

ok,success

リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
応答 (JSON形式)
{
    "status": "success",
    "auction_details": {
        "auction_json": {
            "auction_id": 12,
            "domain": "example.com",
            "utf_name": "example.com",
            "is_idn": false,
            "auction_type": "expired",
            "current_bid_price": "44.99",
            "accepted_bid_price": "45.99",
            "currency": "USD",
            "is_high_bidder": true,
            "bids": 3,
            "bidders": 2,
            "time_left": "2 days, 22 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "revenue": "$26.50",
            "visitors": 245,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-",
            "auction_ended": false,
            "customer_bided": true,
            "customer_bid": "44.99",
            "customer_proxy_bid": "$121.00"
        },
        "bid_history": [
            {
                "bidder_name": "You",
                "bid_price": "44.99",
                "currency": "USD",
                "timestamp": 1648892255084,
                "bid_status": "High Bidder",
                "is_proxy_auto_bid": false
            }
            ...        ]
    }
}
 

クローズド オークション取得コマンド

マルチスレッド対応
API Sandbox はサポートされていません

get closed auctions コマンドを呼び出すと 指定したアカウントの終了済みオークションのリストが返されます. このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

終了オークション取得のリクエストパラメータ
説明
start_dateオークション終了時刻の開始を示すタイムスタンプ, yyyy-mm-dd, 2015-05-05 のような形式
end_dateオークション終了時刻の終端を示すタイムスタンプ, yyyy-mm-dd, 例 2015-05-05
currency (optional)入札の通貨。"usd"、"eur"、または "cny" である必要があります。デフォルトの通貨は米ドルです。
結果XMLタグ
説明
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>閉じたオークション応答のタグ。応答XMLドキュメントのルートノードです
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>終了したオークションのヘッダーを取得
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetClosedAuctionsContent></GetClosedAuctionsContent>Tag of get closed auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>オークションのID
<Domain></Domain>オークションのドメイン名
<AuctionStatusId></AuctionStatusId>オークションのステータスID, '0'は進行中であり'1'はユーザーによる終了, '2'は管理者による終了, '3'は更新による終了, '4'はタイムアウトによる終了, '5'は転出による終了
<AuctionStatus></AuctionStatus>オークションのステータス
<BidPrice></BidPrice>オークションの現在の入札価格
<BidPriceCurrency></BidPriceCurrency>入札価格の通貨
<Bids></Bids>オークション入札数
<AuctionWonStatus></AuctionWonStatus>ユーザーがこのオークションを落札した場合
<YourHighBid></YourHighBid>このオークションへのあなたの最高入札額
<YourProxyBid></YourProxyBid>このオークションへのあなたの代理入札

終了したオークションを取得する例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedAuctionsResponse>
  <GetClosedAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedAuctionsContent>
    <Auction>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
    <Auction>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
  </GetClosedAuctionsContent>
</GetClosedAuctionsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
応答 (JSON形式)
{
  "GetClosedAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0"
      },
      {
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0"
      }
    ]
  }
}
リクエスト (CSV形式)https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
サンドボックスリクエスト (CSV形式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
応答 (CSV形式)
ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0
 

オープンバックオーダーオークション取得コマンド

マルチスレッド対応
API Sandbox はサポートされていません

get open backorder auctions コマンドを呼び出すと進行中のバックオーダーオークションのリストが返されます. このコマンドを呼び出す場合は, 以下のパラメータを含める必要があります:

オープンバックオーダーオークション取得リクエストパラメータ
説明
currency (optional)返される結果の通貨。"usd"、"eur"、"cny" のいずれかである必要があります。デフォルト通貨は米ドルです
結果XMLタグ
説明
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>get open backorder auctions レスポンスのタグ。これはレスポンス XML ドキュメントのルートノードです
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>オープンバックオーダーオークションのヘッダーを取得
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Tag of get open backorder auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>オークションのID
<Domain></Domain>オークションのドメイン名
<BidPrice></BidPrice>オークションの現在の入札価格
<BidPriceCurrency></BidPriceCurrency>入札価格の通貨
<Bids></Bids>オークション入札数
<EndTime></EndTime>オークション終了時刻
<EndTimestamp></EndTimestamp>オークションの終了日時(Unix時間、1970年1月1日午前0時UTCからのミリ秒)

オープン・バックオーダー・オークションの取得例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_backorder_auctions&currency=usd
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_open_backorder_auctions&currency=usd
応答 (XML形式)
<GetOpenBackorderAuctionsResponse>
  <GetOpenBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenBackorderAuctionsHeader>
  <GetOpenBackorderAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    .
    .
    .
  </GetOpenBackorderAuctionsContent>
</GetOpenBackorderAuctionsResponse>
リクエスト(csv形式)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_backorder_auctions¤cy=usd

応答

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp
10000,backorder0.com,6.35,USD,0,2017/08/29 17:53 UTC,1504029194453
10001,backorder1.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
10002,backorder2.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
.
.
.

 

バックオーダーオークション詳細取得コマンド

マルチスレッド対応
API Sandbox はサポートされていません

get backorder auction details コマンドを呼び出すと、指定されたオークションの詳細が返されます。このコマンドは XML および JSON 形式でのみ利用できます。このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

オークション詳細取得リクエストパラメータ
説明
domainバックオーダーオークションのドメイン名。IDN(国際化ドメイン名)は "xn--wkccg.com" のような punycode を使用する必要があります
currency (optional)返される結果の通貨。"usd"、"eur"、"cny" のいずれかである必要があります。デフォルト通貨は米ドルです
結果XMLタグ
説明
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>オークション詳細取得レスポンスのタグ。これはレスポンスXMLドキュメントのルートノードです。
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>オークション詳細取得ヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "success"
<AuctionStatusId></AuctionStatusId>オークションのステータスID, '0'は進行中であり'1'はユーザーによる終了, '2'は管理者による終了, '3'は更新による終了, '4'はタイムアウトによる終了, '5'は転出による終了
<AuctionStatus></AuctionStatus>オークションのステータス
<AuctionId></AuctionId>オークションのID
<Domain></Domain>オークションのドメイン名
<BidPrice></BidPrice>オークションの現在の入札価格
<BidPriceCurrency></BidPriceCurrency>入札価格の通貨
<Bids></Bids>オークション入札数
<EndTime></EndTime>オークション終了時刻
<EndTimestamp></EndTimestamp>オークションの終了日時(Unix時間、1970年1月1日午前0時UTCからのミリ秒)
<Revenue></Revenue>オークションの収益
<RevenueCurrency></RevenueCurrency>収益の通貨
<Visitors></Visitors>ドメインの訪問者
<Links></Links>ドメインの被リンク
<Age></Age>ドメインの年齢
<UserIsHighBid></UserIsHighBid>ユーザーが最高入札者の場合
<YourCurrentBid></YourCurrentBid>指定されたオークションの現在の入札価格です。入札していない場合は '-1' になります
<YourProxyBid></YourProxyBid>あなたの プロキシ入札 指定されたオークションの場合. 入札していない場合, '-1'になります

バックオーダーオークション詳細取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetBackorderAuctionDetailsResponse>
  <GetBackorderAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetBackorderAuctionDetailsHeader>
  <GetBackorderAuctionDetailsContent>
    <AuctionStatusId>0</AuctionStatusId>
    <AuctionStatus>In Progress</AuctionStatus>
    <UserIsHighBid>no</UserIsHighBid>
    <YourCurrentBid>-1</YourCurrentBid>
    <YourProxyBid>-1</YourProxyBid>
    <Auction>
      <AuctionId>10001</AuctionId>
      <Domain>example.com</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>2015/04/28 18:16 UTC</EndTime>
      <EndTimestamp>1430244969779</EndTimestamp>
    </Auction>
  </GetBackorderAuctionDetailsContent>
</GetBackorderAuctionDetailsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
応答 (JSON形式)
{
  "GetBackorderAuctionDetailsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetBackorderAuctionDetails": {
      "AuctionStatusId": "0",
      "AuctionStatus": "In Progress",
      "UserIsHighBid": "no",
      "YourCurrentBid": "-1",
      "YourProxyBid": "-1",
      "Auction": {
        "AuctionId": "10001",
        "Domain": "example.com",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "0",
        "EndTime": "2015/04/28 18:16 UTC",
        "EndTimestamp": "1430244969779"
      }
    }
  }
}
 

バックオーダーオークション入札コマンドを発行

マルチスレッド対応
API Sandbox はサポートされていません

place backorder auction bidコマンドを呼び出すと、指定されたバックオーダーオークションに入札します。このコマンドを呼び出す場合、以下のパラメータを含める必要があります:

バックオーダーオークション入札リクエスト実行パラメータ
説明
domainオークションのドメイン名。IDN(国際化ドメイン名)は punycode を使用してください。例:"xn--wkccg.com"
bid_amountオークションへの入札金額。デフォルトの通貨は米ドルですが、以下のcurrencyパラメータで指定することもできます。
currency (optional)入札の通貨。"usd"、"eur"、または "cny" である必要があります。デフォルトの通貨は米ドルです。
結果XMLタグ
説明
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>オークション入札レスポンスのタグで、レスポンスXMLドキュメントのルートノードです
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>オークション入札のヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

バックオーダーオークション入札の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
応答 (XML形式)
<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
応答 (JSON形式)
{
   "PlaceBakcorderAuctionBidResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
リクエスト (CSV形式)https://api.dynadot.com/api3.html?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
サンドボックスリクエスト (CSV形式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
応答 (CSV形式)
ok,success
 

終了したバックオーダーオークションを取得するコマンド

マルチスレッド対応
API Sandbox はサポートされていません

get closed backorder auctionsコマンドを呼び出すと、指定されたアカウントのクローズドバックオーダーオークションのリストが返されます。このコマンドを呼び出す場合は、以下のパラメータを含める必要があります。

クローズドバックオーダーオークション取得リクエストパラメータ
説明
start_dateオークションの開始日, yyyy-mm-dd, 例 2015-05-05
end_dateオークションの終了日, yyyy-mm-dd, 例えば 2015-05-05
currency (optional)入札の通貨。"usd"、"eur"、または "cny" である必要があります。デフォルトの通貨は米ドルです。
結果XMLタグ
説明
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>閉じたオークション応答のタグ。応答XMLドキュメントのルートノードです
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>終了したオークションのヘッダーを取得
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Tag of get closed auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<YourHighBid></YourHighBid>このオークションへのあなたの最高入札額
<YourProxyBid></YourProxyBid>このオークションへのあなたの代理入札
<AuctionId></AuctionId>オークションのID
<Domain></Domain>オークションのドメイン名
<AuctionStatusId></AuctionStatusId>オークションのステータスID, '0'は進行中であり'1'はユーザーによる終了, '2'は管理者による終了, '3'は更新による終了, '4'はタイムアウトによる終了, '5'は転出による終了
<AuctionStatus></AuctionStatus>オークションのステータス
<BidPrice></BidPrice>オークションの現在の入札価格
<BidPriceCurrency></BidPriceCurrency>入札価格の通貨
<Bids></Bids>オークション入札数

クローズドバックオーダーオークション取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedBackorderAuctionsResponse>
  <GetClosedBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedBackorderAuctionsHeader>
  <GetClosedBackorderAuctionsContent>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/04 02:20:34 PST</EndTime>
      <EndTimestamp>1649064034033</EndTimestamp>
    </Auction>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/05 02:20:34 PST</EndTime>
      <EndTimestamp>1649150434049</EndTimestamp>
    </Auction>
  </GetClosedBackorderAuctionsContent>
</GetClosedBackorderAuctionsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
応答 (JSON形式)
{
  "GetClosedBackorderAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/04 02:20:34 PST",
        "EndTimestamp": "1649064034033"
      },
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/05 02:20:34 PST",
        "EndTimestamp": "1649150434049"
      }
    ]
  }
}
リクエスト (CSV形式)https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
サンドボックスリクエスト (CSV形式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
応答 (CSV形式)
ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0
 

期限切れのクローズアウトドメインを取得するコマンド

マルチスレッド対応
API Sandbox はサポートされていません

Get Expired Closeout Domainsコマンドを呼び出すと、期限切れクローズアウトドメインを取得します。このコマンドはXMLおよびJSON形式でのみ利用できます。このコマンドを呼び出す場合は、以下のパラメータを含める必要があります:

期限切れクローズアウトドメイン取得リクエストパラメータ
説明
currency(optional)返される結果の通貨。"usd"、"eur"、"cny" のいずれかである必要があります。デフォルト通貨は米ドルです
domain(optional)クローズアウトドメインを検索したい場合は、このパラメータを追加してください
count_per_page (optional)1ページに表示されるエンティティ数
page_index (optional)どのページのエンティティを表示しますか
結果XMLタグ
説明
<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Get Expired Closeout Domains レスポンスのタグ。レスポンス XML ドキュメントのルートノードです
<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>期限切れクローズアウトドメインのヘッダーを取得
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Tag of content, it's only used when status is "success"
<CloseoutItem></CloseoutItem>クローズアウトアイテム
<DomainName></DomainName>ドメイン名
<DomainNameUtf></DomainNameUtf>ドメイン名は utf 形式です
<CurrentPrice></CurrentPrice>現在の価格
<isIdn></isIdn>IDNドメイン名かどうか
<EndTimeStamp></EndTimeStamp>オークションの終了日時(Unix時間、1970年1月1日午前0時UTCからのミリ秒)
<RenewalPrice></RenewalPrice>更新価格
<ExpiredRevenue></ExpiredRevenue>クローズアウトの収益
<DynaAppraisal></DynaAppraisal>DynaAppraisal
<InboundLinks></InboundLinks>ドメインの被リンク
<MonthlyVisitors></MonthlyVisitors>ドメインの訪問者
<Currency></Currency>通貨

期限切れクローズアウトドメインの取得例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
サンドボックスリクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetExpiredCloseoutDomainsResponse>
  <GetExpiredCloseoutDomainsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetExpiredCloseoutDomainsHeader>
  <GetExpiredCloseoutDomainsContent>
    <CloseoutItem>
      <DomainName>test.biz</DomainName>
      <DomainNameUtf>test.biz</DomainNameUtf>
      <CurrentPrice>9.91</CurrentPrice>
      <IsIDN>false</IsIDN>
      <EndTimeStamp>0</EndTimeStamp>
      <RenewalPrice>9.99</RenewalPrice>
      <ExpiredRevenue>9.90</ExpiredRevenue>
      <EstibotAppraisal>1223</EstibotAppraisal>
      <InboundLinks>-1</InboundLinks>
      <MonthlyVisitors>-1</MonthlyVisitors>
      <Currency>usd</Currency>
    </CloseoutItem>
  </GetExpiredCloseoutDomainsContent>
</GetExpiredCloseoutDomainsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
サンドボックスリクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
応答 (JSON形式)
{
  "GetExpiredCloseoutDomainsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Size": 1,
    "CloseoutDomains": [
      {
        "closeoutItem": {
          "domainName": "test.biz",
          "domainNameUtf": "test.biz",
          "currentPrice": "9.91",
          "isIdn": false,
          "endTimeStamp": 0,
          "renewalPrice": "9.99",
          "expiredRevenue": "9.90",
          "estibotAppraisal": "1223",
          "inboundLinks": -1,
          "monthlyVisitors": -1,
          "currency": "usd"
        }
      }
    ]
  }
}
 

期限切れクローズアウトドメイン購入コマンド

マルチスレッド対応
API Sandbox はサポートされていません

Buy Expired Closeout Domainコマンドを呼び出すと、指定されたドメイン名を購入します。このコマンドはXMLおよびJSON形式でのみ利用可能です。このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

期限切れクローズアウトドメイン購入リクエストパラメータ
説明
domain購入したいドメイン, 1リクエストにつき1ドメインのみ入力できます
currency(optional)返される結果の通貨。"usd"、"eur"、"cny" のいずれかである必要があります。デフォルト通貨は米ドルです
結果XMLタグ
説明
<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>期限切れクローズアウトドメイン購入応答のタグ。応答XMLドキュメントのルートノードです
<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>期限切れクローズアウトドメインを購入するヘッダー
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

期限切れクローズアウトドメインの購入例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
サンドボックスリクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
サンドボックスリクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
応答 (JSON形式)
{
  "BuyExpiredCloseoutDomainResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

リスティング取得コマンド

マルチスレッド対応
API Sandbox はサポートされていません

get listings コマンドを呼び出す場合, 次のパラメータを含める必要があります:

リスティング取得リクエストパラメータ
説明
currency (optional)返される結果の通貨。"usd"、"eur"、"cny" のいずれかである必要があります。デフォルト通貨は米ドルです
exclude_pending_sale (optional)If you don't want to get pending sale lock listings, it should be "yes", default is "no"
show_other_registrar (optional)他のレジストラのリスティングを取得したい場合は "yes" にする必要があります。デフォルトは "no" です。
count_per_page1ページに表示されるエンティティ数。(最大20000)
page_indexどのページのエンティティを表示しますか.
結果XMLタグ
説明
<GetListingsResponse></GetListingsResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<GetListingsHeader></GetListingsHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetListingsContent></GetListingsContent>リスティング内容
<Listing></Listing>出品アイテムの内容
<ListingId></ListingId>リスティングID
<Domain></Domain>ドメイン名
<Price></Price>価格
<InBoundLinks></InBoundLinks>被リンク数
<Age></Age>経過年数

リスティング取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsResponse>
  <GetListingsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsHeader>
  <GetListingsContent>
    <Listing>
      <ListingId>id1</ListingId>
      <Domain>domain_name1</Domain>
      <Price>1</Price>
      <InboundLinks>1</InboundLinks>
      <Age>1</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
      <Type>BIN</Type>
      <RegistrationDate>1791875010217</RegistrationDate>
      <ExpirationDate>1791875010217</ExpirationDate>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
      <Type>MAKE_OFFER</Type>
      <RegistrationDate>1791875010217</RegistrationDate>
      <ExpirationDate>1791875010217</ExpirationDate>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
応答 (JSON形式)
{
  "GetListingsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Total": 2,
    "Listing": [
      {
        "ListingId": "id1",
        "Domain": "domain_name1",
        "Price": "1",
        "InboundLinks": "1",
        "Age": "1",
        "PendingSaleLocked": "No",
        "RegistrationDate": 1791875010217,
        "ExpirationDate": 1791875010217,
        "Type": "BIN"
      },
      {
        "ListingId": "id2",
        "Domain": "domain_name2",
        "Price": "2",
        "InboundLinks": "2",
        "Age": "2",
        "PendingSaleLocked": "No",
        "RegistrationDate": 1791875010217,
        "ExpirationDate": 1791875010217,
        "Type": "MAKE_OFFER"
      }
    ]
  }
}
 

リスティングアイテム取得コマンド

マルチスレッド対応
API Sandbox はサポートされていません

get listing item コマンドを呼び出す場合は, 次のパラメータを含める必要があります:

出品アイテム取得リクエストパラメータ
説明
domain詳細を取得したいドメイン名, 1回のリクエストにつき1つのドメインのみ入力できます
currency (optional)返される結果の通貨。"usd"、"eur"、"cny" のいずれかである必要があります。デフォルト通貨は米ドルです
結果XMLタグ
説明
<GetListingItemResponse></GetListingItemResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<GetListingItemHeader></GetListingItemHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetListingsItemContent></GetListingsItemContent>リスティング内容
<Listing></Listing>出品アイテムの内容
<ListingId></ListingId>リスティングID
<Domain></Domain>ドメイン名
<Price></Price>価格
<InBoundLinks></InBoundLinks>被リンク数
<Age></Age>経過年数

出品アイテム取得例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_listing_item&currency=usd&domain=domain_name
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsItemResponse>
  <GetListingsItemHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsItemHeader>
  <GetListingsItemContent>
    <Listing>
      <ListingId>id</ListingId>
      <Domain>domain_name</Domain>
      <Price>0</Price>
      <InboundLinks>0</InboundLinks>
      <Age>0</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
      <Type>BIN</Type>
      <RegistrationDate>1791875010218</RegistrationDate>
      <ExpirationDate>1791875010218</ExpirationDate>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_listing_item&currency=usd&domain=domain_name
応答 (JSON形式)
{
  "GetListingsItemResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": {
      "ListingId": "id",
      "Domain": "domain_name",
      "Price": "0",
      "InboundLinks": "0",
      "Age": "0",
      "PendingSaleLocked": "No",
      "RegistrationDate": 1791875010218,
      "ExpirationDate": 1791875010218,
      "Type": "BIN"
    }
  }
}
 

今すぐ購入コマンド

マルチスレッド対応
API Sandbox はサポートされていません

Buy It Nowコマンドを呼び出す場合は、次のパラメータを含める必要があります:

今すぐ購入リクエストパラメータ
説明
domain購入したいドメイン, 1リクエストにつき1ドメインのみ入力できます
currency (optional)戻り値の通貨。"usd"、"eur"、または"cny"でなければなりません。通貨が入力されていない場合は、アカウントのデフォルト通貨が適用されます。
price_to_verify (optional)購入前に検証するための期待される buy_it_now 価格。実際の出品価格がこの値と一致しない場合、リクエストは失敗します。
結果XMLタグ
説明
<BuyItNowResponse></BuyItNowResponse>レスポンスXMLドキュメントのルートノードXMLドキュメント
<BuyItNowHeader></BuyItNowHeader>レスポンスヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<Message></Message>"domain order created" である必要があり、status が "success" の場合にのみ使用されます。

今すぐ購入の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<BuyItNowResponse>
  <BuyItNowHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BuyItNowHeader>
  <BuyItNowContent>
    <OrderId>1</OrderId>
  </BuyItNowContent>
</BuyItNowResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
応答 (JSON形式)
{
  "BuyItNowResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderId": 1
  }
}
 

新しいリードを追加するコマンド

マルチスレッド対応
API Sandbox はサポートされていません

Add New Leadコマンドを呼び出すと、5%の手数料率で自分のリードをDynadotのシステムにインポートします。

注: ドメインはロック解除され、買い手が承諾後すぐにチェックアウトできるようになります。

このコマンドはXML形式とJSON形式でのみ利用できます.このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

新しいリードを追加するリクエストパラメータ
説明
domain_nameリードを追加するドメイン名です。1回のリクエストにつき1つのドメインのみ入力できます
lead_typeリードを設定したいリードタイプです. 指定可能な値は "buy_now", "make_offer"
priceリードに設定する価格
buyer_name購入者名
buyer_email購入者のメールアドレス
結果XMLタグ
説明
<AddNewLeadResponse></AddNewLeadResponse>レスポンスのルートノード
<AddNewLeadHeader></AddNewLeadHeader>新しいリードを追加するヘッダー
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

新規リード追加の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<AddNewLeadResponse>
  <AddNewLeadHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AddNewLeadHeader>
</AddNewLeadResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
応答 (JSON形式)
{
  "AddNewLeadResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

販売設定コマンド

マルチスレッド対応
API Sandbox はサポートされていません

このコマンドはマルチスレッドをサポートしています。

Set For Sale コマンドを呼び出すと、ドメインマーケットプレイスにドメインが販売用としてリストされます。このコマンドは XML および JSON 形式でのみ利用可能です。このコマンドを呼び出す場合は、以下のパラメータを含める必要があります:

For Sale設定リクエストパラメータ
説明
domainsドメインマーケットプレイスで販売するためにリストするドメイン。リクエストごとに1つのドメインのみ入力できます
for_sale_type販売タイプを表すために以下のリストから値を選択できます:
> マーケットプレイス:
ドメインを出品する場所: ドメインマーケットプレイス. 新規ドメインリスティングは以下に入力されたカテゴリ, サブカテゴリ, および価格に設定されます. 実際の価格が設定されている場合, そのドメインはすぐに購入可能となり購入者にプッシュされます. ドメイン販売プロセスに関する詳細 >

> 非売品:
リスティングをキャンセル
listing_type (optional)マーケット経由の販売タイプを表す値は、次のリストから選択できます: (for_sale_type が marketplace の場合は必須)
> buy_now
固定価格を設定すると、ドメインが即時購入可能になり、購入者にプッシュされます。
注: 追加猶予期間にあるドメインは、売却があると、グレース削除できなくなる場合があります。詳細については 猶予期間中の削除

> make_offer
最低入札価格を設定するか、空白のままにしておくと任意の金額を受け付けることができます。
注: 追加猶予期間にあるドメインは、売却があると、グレース削除できなくなる場合があります。詳細については 猶予期間中の削除

> buy_now_and_make_offer 固定価格を設定すると、ドメインがすぐに購入可能な状態になり、買い手にプッシュされます.
最低入札価格を設定するか、空白のままにしておくと任意の金額を受け付けることができます。
注: 追加猶予期間にあるドメインは、売却があると、グレース削除できなくなる場合があります。詳細については 猶予期間中の削除
price (optional)ドメインを販売したい価格. (for_sale_type が marketplace の場合は必須)
minimum_offer (optional)ドメインに対して受け入れる最低オファー額. (for_sale_typeがmarketplaceの場合は必須)
installment (optional)分割払いは許可されていますか。分割払いを有効にしたい場合は、"Yes" に設定してください
maximum_installments (optional)分割払いが "true" の場合にのみ使用される、許可される最大分割回数
分割払いの最大月数を表すために、2から12までの値を選択できます
category (optional)ドメインのカテゴリを選択してください, 任意で入力する場合は以下のカテゴリとサブカテゴリの比較表を参照できます.
Sub-category (optional)ドメインのサブカテゴリを選択してください, 選択には以下のカテゴリとサブカテゴリの比較表を参照できます.
注意: パラメータ値は Sub-category に対応する番号である必要があります.
カテゴリサブカテゴリ
advertisingmarketing
retail
sales
automotivecars_trucks
enthusiasts
motorsports
businessinvestment
law
money
professions
services
careers_educationNo subCategory
consumer_goods_servicesapparel
electronics
entertainmentgames
pop_culture
fashionNo subCategory
financeNo subCategory
gamblingcasino
sports
healthfitness
medicine
internetblogs
ecommerce
domains
web_design
web_hosting
otherNo subCategory
placesafrica
asia
europe
north_america
south_america
real_estateNo subCategory
scienceNo subCategory
societyculture
news
politics
religion
sportsleisure_activities
professional
technologycomputers
uncategorizedNo subCategory
adultNo subCategory
homeNo subCategory
aiNo subCategory
aerospaceNo subCategory
agencyNo subCategory
agriculture_companyNo subCategory
analyticsNo subCategory
alcoholNo subCategory
babies_kidsNo subCategory
biotechNo subCategory
clean_energyNo subCategory
cleaningNo subCategory
communityNo subCategory
construction_organizationNo subCategory
cryptocurrency_blockchainNo subCategory
dating_relationshipNo subCategory
daycareNo subCategory
dentalNo subCategory
droneNo subCategory
e_commerceNo subCategory
food_drinkNo subCategory
furnitureNo subCategory
gamesNo subCategory
insuranceNo subCategory
interior_designNo subCategory
legal_lawNo subCategory
motivationalNo subCategory
manufacturingNo subCategory
marketingNo subCategory
medicalNo subCategory
metaverseNo subCategory
movies_tvNo subCategory
music_audioNo subCategory
news_mediaNo subCategory
nftNo subCategory
outdoorNo subCategory
paymentNo subCategory
petsNo subCategory
politicsNo subCategory
property_managementNo subCategory
recruitment_staffingNo subCategory
servicesNo subCategory
securityNo subCategory
socialNo subCategory
transportationNo subCategory
travelNo subCategory
video_books_magazinesNo subCategory
virtual_realityNo subCategory
website_designNo subCategory
Description (optional)あなたのドメインの説明
結果XMLタグ
説明
<SetForSaleResponse></SetForSaleResponse>レスポンスのルートノード
<SetForSaleHeader></SetForSaleHeader>For Sale ヘッダーを設定
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

販売設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetForSaleResponse>
  <SetForSaleHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetForSaleHeader>
</SetForSaleResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
応答 (JSON形式)
{
  "SetForSaleResponse": {
    "ResponseCode: ": "0",
    "Status": "Success"
  }
}
 

ドメイン転出リストコマンド

マルチスレッド対応
APIサンドボックス対応

転出ドメインリストコマンドを呼び出すと処理中の転出ドメインリストを取得できます. このコマンドは XML と JSON 形式でのみ利用可能です.このコマンドを呼び出すと

ドメイン移出リストリクエストパラメータ
説明
結果XMLタグ
説明
<TransferOutDomainListResponse></TransferOutDomainListResponse>レスポンスのルートノード
<TransferOutDomainListHeader></TransferOutDomainListHeader>Transfer Out Domain List ヘッダー
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<TransferOutDomainListContent></TransferOutDomainListContent>Transfer Out Domain List ヘッダー
<TransferOutDomainList></TransferOutDomainList>転出ドメインの一覧
<Domain></Domain>ドメイン名
<OrderId></OrderId>転出ドメインの注文ID
<ItemStatus></ItemStatus>転出ドメインのステータス

転出ドメインリストの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer_domain_list
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=transfer_domain_list
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<TransferOutDomainListResponse>
  <TransferOutDomainListHeader>
    <ResponseCode>200</ResponseCode>
    <Status>success</Status>
  </TransferOutDomainListHeader>
  <TransferOutDomainListContent>
    <TransferOutDomainList>
      <TransferOutDomain>
        <OrderId>1</OrderId>
        <Domain>domain1.com</Domain>
        <ItemStatus>Pending</ItemStatus>
      </TransferOutDomain>
    </TransferOutDomainList>
  </TransferOutDomainListContent>
</TransferOutDomainListResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer_domain_list
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=transfer_domain_list
応答 (JSON形式)
{
  "TransferOutDomainListResponse": {
    "ResponseCode": 200,
    "Status": "success",
    "TransferOutDomainList": [
      {
        "orderId": 1,
        "domain": "domain1.com",
        "itemStatus": "Pending"
      }
    ]
  }
}
 

Afternic確認アクションコマンドを設定

マルチスレッド対応
API Sandbox はサポートされていません

Set Afternic Confirm Actionコマンドを呼び出すとAfternicでのファストトランスファーを承認または否認するようにドメインを設定します。このコマンドはXMLおよびJSON形式でのみ利用可能です。このコマンドを呼び出す場合、以下のパラメータを含める必要があります:

Afternic 確認アクション設定リクエストパラメータ
説明
domainAfternic confirm fast transfer アクションを設定したいドメイン、1回のリクエストにつき1つのドメインのみ入力できます
actionAfternic の確認に設定したいアクションです。"confirm_afternic" または "delete_from_afternic" のいずれかである必要があります。
結果XMLタグ
説明
<SetAfternicConfirmActionResponse></SetAfternicConfirmActionResponse>Set Afternic Confirm Action レスポンスのタグ。これはレスポンス XML ドキュメントのルートノードです
<SetAfternicConfirmActionHeader></SetAfternicConfirmActionHeader>Afternic確認アクションヘッダーを設定
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

Afternic確認アクション設定例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
サンドボックスリクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetAfternicConfirmActionResponse>
  <SetAfternicConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetAfternicConfirmActionHeader>
</SetAfternicConfirmActionResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
サンドボックスリクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
応答 (JSON形式)
{
  "SetAfternicConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Sedo確認アクションコマンドを設定

マルチスレッド対応
API Sandbox はサポートされていません

Sedo確認アクション設定コマンドを呼び出すと、Sedoでの高速転送を承認または非承認にするようにドメインを設定します。このコマンドはXMLおよびJSON形式でのみ使用できます。このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

Sedo確認アクション設定リクエストパラメータ
説明
domainSedoの高速転送確認アクションを設定したいドメイン。1回のリクエストにつき1つのドメインのみ入力できます
actionsedo の確認に設定するアクションです, "confirm_sedo" または "delete_from_sedo" のいずれかである必要があります
結果XMLタグ
説明
<SetSedoConfirmActionResponse></SetSedoConfirmActionResponse>Set Sedo Confirm Action レスポンスのタグ。これはレスポンス XML ドキュメントのルートノードです
<SetSedoConfirmActionHeader></SetSedoConfirmActionHeader>SedoのConfirm Actionヘッダーを設定
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。

Sedo確認アクション設定の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
サンドボックスリクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<SetSedoConfirmActionResponse>
  <SetSedoConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetSedoConfirmActionHeader>
</SetSedoConfirmActionResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
サンドボックスリクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
応答 (JSON形式)
{
  "SetSedoConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Whois統計取得コマンド

マルチスレッド対応
APIサンドボックス対応

Whois統計取得コマンドを呼び出すと、whois統計を取得します。このコマンドはXML形式とJSON形式でのみ利用できます。このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

Whois統計取得のリクエストパラメータ
説明
domain_nameDNSSECを設定する必要があるドメイン名
date_type日付タイプを表すには、次のリストからフィールドを選択できます:
last_7_days, last_30_days, current_year, last_year
結果XMLタグ
説明
<GetWhoisStatsResponse></GetWhoisStatsResponse>レスポンスのルートノード
<GetWhoisStatsHeader></GetWhoisStatsHeader>Whois統計取得のヘッダー
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetWhoisStatsContent></GetWhoisStatsContent>レスポンス内容
<WhoisStats></WhoisStats>複数セットの whois stat データを含みます
<WhoisStat></WhoisStat>特定のWhois統計データ
<Date></Date>最小時間間隔
<Count></Count>現在の時間間隔内の whois の数

Whois統計取得の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetWhoisStatsResponse>
  <GetWhoisStatsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetWhoisStatsHeader>
  <GetWhoisStatsContent>
    <WhoisStats>
      <WhoisStat>
        <Date>2023-11-04</Date>
        <Count>200</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-05</Date>
        <Count>300</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-06</Date>
        <Count>100</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-07</Date>
        <Count>200</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-08</Date>
        <Count>300</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-09</Date>
        <Count>100</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-10</Date>
        <Count>200</Count>
      </WhoisStat>
    </WhoisStats>
  </GetWhoisStatsContent>
</GetWhoisStatsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
応答 (JSON形式)
{
  "GetWhoisStatsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "WhoisStats": [
      {
        "Date": "2023-11-04",
        "Count": 200
      },
      {
        "Date": "2023-11-05",
        "Count": 300
      },
      {
        "Date": "2023-11-06",
        "Count": 100
      },
      {
        "Date": "2023-11-07",
        "Count": 200
      },
      {
        "Date": "2023-11-08",
        "Count": 300
      },
      {
        "Date": "2023-11-09",
        "Count": 100
      },
      {
        "Date": "2023-11-10",
        "Count": 200
      }
    ]
  }
}
 

注文一覧コマンド

マルチスレッド対応
APIサンドボックス対応

Order Listコマンドを呼び出すと、注文リストを取得します。このコマンドはXMLおよびJSON形式でのみ使用可能です。このコマンドを呼び出す場合、以下のパラメータを含める必要があります:

注文一覧リクエストパラメータ
説明
search_by検索タイプを表す値として、次のリストから選択できます: date_range, domain, order_id
start_dateyyyy/MM/dd形式のクエリの開始日
end_dateクエリの終了日(yyyy/MM/dd形式)
payment_method支払い方法を表すために、以下のリストから複数の値を選択できます:
none_balance
アカウント残高
クレジットカード
マネーオーダー
Paypal
Moneybooker
銀行振込
Alipay
payflow_credit_card2(現在は使用されていません)
wechat_pay
eキャッシュ
銀行振込
apple_pay
当座預金
販売
union_pay
ペイパルアカウント
mercado_pago
Payoneer
ただし, 複数の値を区切るにはカンマを使用してください, 例: account_balance,credit_card
結果XMLタグ
説明
<OrderListResponse></OrderListResponse>レスポンスのルートノード
<OrderListHeader></OrderListHeader>注文リストのヘッダー
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<OrderListContent></OrderListContent>注文リストのヘッダー
<OrderList></OrderList>複数セットの注文ログデータが含まれます
<OrderItem></OrderItem>単一の注文ログデータが含まれます
<OrderItemDomain></OrderItemDomain>この注文の項目を含むドメイン名
<OrderId></OrderId>注文のIDが含まれます
<SubmittedDate></SubmittedDate>注文が送信された日付を含みます
<Cost></Cost>注文の費用が含まれています
<Status></Status>注文のステータスが含まれます

注文リストの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<OrderListResponse>
  <OrderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </OrderListHeader>
  <OrderListContent>
    <OrderList>
      <Order>
        <OrderId>123456</OrderId>
        <SubmittedDate>1791875010219</SubmittedDate>
        <Currency>USD</Currency>
        <PaymentMethod>Account Balance</PaymentMethod>
        <TotalCost>$8.00</TotalCost>
        <TotalPaid>$8.00</TotalPaid>
        <Status>Problem</Status>
        <OrderItem>
          <ItemType>Domain Registration</ItemType>
          <Name>test.com</Name>
          <Duration>1</Duration>
          <Cost>2.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Renewal</ItemType>
          <Name>test1.ac</Name>
          <Duration>1</Duration>
          <Cost>3.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Transfer</ItemType>
          <Name>test2.de</Name>
          <Duration>1</Duration>
          <Cost>4.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Registration</ItemType>
          <Name>test3.gg</Name>
          <Duration>1</Duration>
          <Cost>5.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Renewal</ItemType>
          <Name>test4.uk</Name>
          <Duration>1</Duration>
          <Cost>6.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Transfer</ItemType>
          <Name>test5.net</Name>
          <Duration>1</Duration>
          <Cost>7.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
      </Order>
      <Order>
        <OrderId>123457</OrderId>
        <SubmittedDate>1791875010219</SubmittedDate>
        <Currency>EUR</Currency>
        <PaymentMethod>Paypal</PaymentMethod>
        <TotalCost>$100.00</TotalCost>
        <TotalPaid>$100.00</TotalPaid>
        <Status>Submitted</Status>
      </Order>
    </OrderList>
  </OrderListContent>
</OrderListResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
応答 (JSON形式)
{
  "OrderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderList": [
      {
        "OrderId": "123456",
        "SubmittedDate": "2026/10/13",
        "Currency": "USD",
        "PaymentMethod": "Account Balance",
        "TotalCost": "$8.00",
        "TotalPaid": "$8.00",
        "Status": "Problem",
        "ItemList": [
          {
            "ItemType": "Domain Registration",
            "Name": "test.com",
            "Duration": 1,
            "Cost": "2.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Renewal",
            "Name": "test1.ac",
            "Duration": 1,
            "Cost": "3.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Transfer",
            "Name": "test2.de",
            "Duration": 1,
            "Cost": "4.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Registration",
            "Name": "test3.gg",
            "Duration": 1,
            "Cost": "5.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Renewal",
            "Name": "test4.uk",
            "Duration": 1,
            "Cost": "6.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Transfer",
            "Name": "test5.net",
            "Duration": 1,
            "Cost": "7.99",
            "Status": "Completed"
          }
        ]
      },
      {
        "OrderId": "123457",
        "SubmittedDate": "2026/10/13",
        "Currency": "EUR",
        "PaymentMethod": "Paypal",
        "TotalCost": "$100.00",
        "TotalPaid": "$100.00",
        "Status": "Submitted",
        "ItemList": []
      }
    ]
  }
}
 

注文ステータス取得コマンド

マルチスレッド対応
APIサンドボックス対応

Get Order Status コマンドを呼び出すと、注文ステータスを取得できます。このコマンドは XML および JSON 形式でのみ利用できます。このコマンドを呼び出す場合は、次のパラメータを含める必要があります:

注文ステータス取得リクエストパラメータ
説明
order_id照会する注文のID
結果XMLタグ
説明
<GetOrderStatusResponse></GetOrderStatusResponse>レスポンスのルートノード
<GetOrderStatusHeader></GetOrderStatusHeader>注文ステータスのヘッダーを取得
<ResponseCode></ResponseCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<GetOrderStatusContent></GetOrderStatusContent>レスポンス内容
<OrderId></OrderId>注文ID
<OrderStatus></OrderStatus>注文ステータス( Shopping, Submitted, Waitpay, Processing, Completed, Problem, Deleted, Cancelled )
<ItemTypeName></ItemTypeName>アイテムタイプ
<ItemName></ItemName>項目名
<ItemStatus></ItemStatus>アイテムステータス(完了、キャンセル、問題あり)

注文ステータス取得例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
サンドボックスリクエスト (XML形式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<GetOrderStatusResponse>
  <GetOrderStatusHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetOrderStatusHeader>
  <GetOrderStatusContent>
    <OrderId>0</OrderId>
    <OrderStatus>Completed</OrderStatus>
    <Item>
      <ItemTypeName>domain transfer away</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>transfer.com</ItemStatus>
    </Item>
    <Item>
      <ItemTypeName>domain</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>register.com</ItemStatus>
    </Item>
  </GetOrderStatusContent>
</GetOrderStatusResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
サンドボックスリクエスト (JSON形式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
応答 (JSON形式)
{
  "GetOrderStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderStatus": {
      "OrderId": 0,
      "OrderStatus": "Completed",
      "ItemList": [
        {
          "ItemTypeName": "domain transfer away",
          "ItemName": "transfer.com",
          "ItemStatus": "Completed"
        },
        {
          "ItemTypeName": "domain",
          "ItemName": "register.com",
          "ItemStatus": "Completed"
        }
      ]
    }
  }
}
 

処理中コマンド

マルチスレッド対応
APIサンドボックス対応

is_processing コマンドを呼び出すと、新しいリクエストを送信しても安全かどうかがわかります。

処理中かどうかを示すリクエストパラメータ
説明
追加のパラメータは不要です
結果XMLタグ
説明
<Response></Response>is_processing レスポンスのタグ
<ResponseHeader></ResponseHeader>is_processing ヘッダーのタグ
<ResponseMsg></ResponseMsg>Tag of is_processing response message. It should be "yes"(There is a process in the system. You shouldn't sent another request.) or "no"(There is no any process for you account. It is safe to submit a new request.)

Is-Processingの例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=is_processing
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=is_processing
応答 (XML形式)
<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=is_processing
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=is_processing
応答 (JSON形式)
{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}
リクエスト (CSV形式)https://api.dynadot.com/api3.html?key=[API Key]&command=is_processing
サンドボックスリクエスト (CSV形式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=is_processing
応答 (CSV形式)
ok,yes
 

クーポン一覧コマンド

マルチスレッド対応
APIサンドボックス対応

List Coupons コマンドを呼び出すとすべてのクーポンを取得できます. このコマンドは XML および JSON 形式でのみ利用可能です. このコマンドを呼び出す場合, 次のパラメータを含める必要があります:

クーポン一覧取得リクエストパラメータ
説明
coupon_type検索タイプを表すには、次のリストから値を選択できます: "registration"、"renewal"、または "transfer"
結果XMLタグ
説明
<ListCouponsResponse></ListCouponsResponse>レスポンスのルートノード
<ListCouponsHeader></ListCouponsHeader>クーポン一覧ヘッダー
<SuccessCode></SuccessCode>操作が成功した場合、成功は "0"、失敗は "-1" です。
<Status></Status>リクエストのステータス
<Error></Error>リクエストに関するエラー情報、statusが "error" の場合にのみ使用されます。
<ListCouponsContent></ListCouponsContent>List Coupons の内容
<Coupons></Coupons>複数セットのクーポンデータが含まれています
<Coupon></Coupon>単一のクーポンデータを含みます
<Code></Code>クーポンコード
<Description></Description>クーポンの説明
<CouponType></CouponType>クーポンの種類
<DiscountType></DiscountType>クーポンで提供される割引の種類
<DiscountInfo></DiscountInfo>クーポンの割引情報
<Percentage></Percentage>割引率
<AUD></AUD>オーストラリアドルでの割引額
<MXN></MXN>メキシコペソでの割引金額
<EUR></EUR>ユーロでの割引額
<GBP></GBP>英国ポンドでの割引額
<IDR></IDR>インドネシアルピアでの割引金額
<USD></USD>米ドルでの割引額
<CAD></CAD>カナダドルでの割引額
<INR></INR>インドルピーでの割引額
<BRL></BRL>ブラジル レアルでの割引額
<CNY></CNY>中国元での割引額
<Restriction></Restriction>クーポンの制限
<PriceLevels></PriceLevels>クーポンの利用に対応する価格レベルのコレクション
<UsesPerAccount></UsesPerAccount>クーポンが1アカウントにつき使用できる回数
<UsesSystemWide></UsesSystemWide>クーポンがシステム全体で使用できる回数
<UsesPerIp></UsesPerIp>クーポンがIPアドレスごとに使用できる回数
<ItemsPerAccount></ItemsPerAccount>アカウントごとにクーポンを利用できるアイテム数
<ItemsSystemWide></ItemsSystemWide>システム全体でクーポンが使用できる項目数
<ItemsPerOrder></ItemsPerOrder>クーポンが1回の注文で使用できるアイテム数
<ItemsPerDay></ItemsPerDay>クーポンが1日あたりに使用できる項目数
<IdnRestriction></IdnRestriction>クーポンのIDN制限
<DomainDurationMin></DomainDurationMin>ドメインの最小期間
<DomainDurationMax></DomainDurationMax>ドメインの最大登録期間
<Tlds></Tlds>クーポンの利用をサポートするトップレベルドメインのコレクション
<Tld></Tld>クーポンの利用に対応する単一のトップレベルドメイン
<Currencies></Currencies>クーポンの使用をサポートする通貨タイプのコレクション
<Currency></Currency>クーポンの利用に対応する単一の通貨タイプ
<StartDate></StartDate>クーポン有効開始日
<EndDate></EndDate>クーポン有効期限の終了日

クーポン一覧の例

リクエスト (XML形式)https://api.dynadot.com/api3.xml?key=[API Key]&command=list_coupons&coupon_type=renewal
サンドボックスリクエスト (XML形式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=list_coupons&coupon_type=renewal
応答 (XML形式)
<?xml version="1.0" encoding="UTF-8"?>
<ListCouponsResponse>
  <ListCouponsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </ListCouponsHeader>
  <ListCouponsContent>
    <Coupons>
      <Coupon>
        <Code>DOMAINRENEW1</Code>
        <Description>Domain Renew Coupon</Description>
        <CouponType>Hosting/SSL Coupons</CouponType>
        <DiscountType>PERCENTAGE_OFF</DiscountType>
        <DiscountInfo>
          <Percentage>10%</Percentage>
        </DiscountInfo>
        <Restriction>
          <PriceLevels>Any</PriceLevels>
          <IdnRestriction>None</IdnRestriction>
          <DomainDurationMin>1</DomainDurationMin>
          <DomainDurationMax>1</DomainDurationMax>
          <Tlds>
            <Tld>.com</Tld>
            <Tld>.net</Tld>
            <Tld>.org</Tld>
          </Tlds>
          <Currencies>
            <Currency>US Dollar USD ($)</Currency>
          </Currencies>
        </Restriction>
        <StartDate>1476811260000</StartDate>
        <EndDate>1483257540000</EndDate>
      </Coupon>
    </Coupons>
  </ListCouponsContent>
</ListCouponsResponse>
リクエスト (JSON形式)https://api.dynadot.com/api3.json?key=[API Key]&command=list_coupons&coupon_type=renewal
サンドボックスリクエスト (JSON形式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=list_coupons&coupon_type=renewal
応答 (JSON形式)
{
  "ListCouponsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Coupons": [
      {
        "Code": "DOMAINRENEW1",
        "Description": "Domain Renew Coupon",
        "CouponType": "Hosting/SSL Coupons",
        "DiscountType": "PERCENTAGE_OFF",
        "DiscountInfo": {
          "Percentage": "10%"
        },
        "Restriction": {
          "PriceLevels": "Any",
          "IdnRestriction": "None",
          "DomainDurationMin": "1",
          "DomainDurationMax": "1",
          "Tlds": [
            ".com",
            ".net",
            ".org"
          ],
          "Currencies": [
            "US Dollar USD ($)"
          ]
        },
        "StartDate": "1476811260000",
        "EndDate": "1483257540000"
      }
    ]
  }
}