API一覧

API一覧

DOMAIN-APIでは以下のAPIが利用できます。

汎用JP型ドメイン管理サービスの契約・解約
管理権限HTTPメソッドAPI名/(サブAPI名)目的
必要

POST

dj

汎用JP型ドメイン管理サービスを契約する

必要

PUT

dj

汎用JP型ドメイン管理サービスで取得したドメインの管理を外部へ移す

必要

DELETE

dj

汎用JP型ドメイン管理サービスを解約する

gTLD型ドメイン管理サービスの契約・解約
管理権限HTTPメソッドAPI名/(サブAPI名)目的
必要

POST

dgj

gTLD型ドメイン管理サービスを契約する

必要

PUT

dgj

gTLD型ドメイン管理サービスで取得したドメインの管理を外部へ移す

必要

DELETE

dgj

gTLD型ドメイン管理サービスを解約する

必要

GET

dgj/(auth_code)

gTLD型ドメイン管理サービスのAuthCodeを確認する

ネームサーバの設定
管理権限HTTPメソッドAPI名/(サブAPI名)目的
不要

GET

name_servers

現在のネームサーバを確認する

不要

PUT

name_servers

ネームサーバを即時設定する

不要

GET

name_servers/(reservation)

ネームサーバの予約状態を確認する

不要

PUT

name_servers/(reservation)

ネームサーバの設定を予約する

不要

DELETE

name_servers/(reservation)

ネームサーバの設定予約を取り消す

ホスト情報の設定(DNSサーバのホスト名・IPアドレスの設定)
管理権限HTTPメソッドAPI名/(サブAPI名)目的
不要

GET

host

DNSサーバのホスト名及びIPアドレスを確認する

不要

PUT

hosts

DNSサーバのホスト名及びIPアドレスを即時設定する

不要

GET

hosts/(reservation)

DNSサーバのホスト名及びIPアドレスの設定の予約状態を確認する

不要

PUT

hosts/(reservation)

DNSサーバのホスト名及びIPアドレスの設定を予約する

不要

DELETE

hosts/(reservation)

DNSサーバのホスト名及びIPアドレスの設定予約を取り消す

DNSSECの設定
管理権限HTTPメソッドAPI名目的
不要

GET

dnssec

DNSSECの設定状態を確認する

不要

PUT

dnssec

DNSSECを設定する

その他
管理権限HTTPメソッドAPI名目的
不要

GET

do_linkage

DNSアウトソースサービスとの連携状態を確認する

不要

GET

echo

API疎通テストを行う

APIバージョン

DOMAIN-APIで提供するAPI群にはバージョンが設定されています。バージョンによって、一部のパラメータや挙動が変化する場合があります。

APIをリクエストする際に、APIVersionパラメータを指定することで、どのバージョンのAPIを実行するかを指定できます。

現在指定可能なAPIVersionは以下のとおりです。

APIVersion利用開始日利用終了日備考
201602012016年3月10日未定初期リリース版

API詳細における凡例 (レスポンス)

各API一覧ページでは、レスポンスの説明に以下のような表記を使用します。

JSON表記
JSON
{
    "SampleApiResponse": {
        "Param1": "abcdefg",
        "Param2": {
            "ParamA": "pqr",
            "ParamB": "xyz"
        },
        "Param3": [
            {
                "ParamC": "123"
            },
            {
                "ParamC": "987"
            }
        ]
    }
}
フィールドタイプ意味
SampleApiResponse.Param1String単純な値
SampleApiResponse.Param2Object内部に複数の値を含む連想配列
SampleApiResponse.Param2.ParamAString構造体に含まれる単純な値
SampleApiResponse.Param2.ParamBString構造体に含まれる単純な値
SampleApiResponse.Param3Array内部に複数の値を含む単純配列
SampleApiResponse.Param3.ParamCString配列に含まれる単純な値
  • 構造化されたフィールドのキーは、表中ではそれぞれのキーを「.」(ドット)で連結して表します。
  • DOMAIN-APIでは値に型はありません。すべて文字列として取り扱います。