XServer API

XServer APIとは

サーバー管理やドメイン管理など各サービスの機能を、外部プログラムやAIエージェントから実行できるREST APIです。
1つのAPIキーで複数サーバー、複数サービスを操作できます。
XServerドメインでは、契約ドメインの情報取得、ネームサーバー設定、Whois設定、ドメイン取得・移管などのドメイン管理機能を操作できます。

ご利用の前に

「属性型JP・プレミアムドメインの取得・移管」「JPドメインの移管」はAPIではご利用になれません。

APIのご利用方法

XServer APIを利用するには、まずAPIキーを発行する必要があります。
APIキーはXServerアカウントから発行・管理が行えます。

APIキーの発行手順

1.「APIキー管理」をクリック

XServerアカウントへログインし、サービスメニューの「APIキー管理」をクリックします。
2.「APIキー追加」をクリック

「APIキー追加」ボタンをクリックします。
3. 必要事項を入力し、「確認画面へ進む」をクリック

各項目を設定し、「確認画面へ進む」をクリックしてください。

API キーの基本設定

APIキー名を入力し、有効期限を選択します。
必要に応じてアクセスを許可するIPアドレスが指定できます。

利用するサービスと権限

APIを利用する対象ドメインを選択します。
操作権限は「すべての操作」「読み取り専用」「カスタム」から選択できます。「カスタム」は操作項目ごとに権限が選択できます。

※APIを提供している契約中のサービスもあわせて設定できます。
「このAPIキーでドメインの新規取得・移管・更新を行う」について

チェックをつけるには、以下条件を満たしている必要があります。
- ・Whois初期値設定が入力済みであること
- ・プリペイド残高が2,000円以上あること（プリペイドのチャージ方法についてはプリペイド決済をご参照ください。）
4. APIキーの確認

発行が完了すると、APIキーが表示されます。APIキーは xs_ で始まる文字列です。