1. ホーム
  2. マニュアル
  3. 管理ツール
  4. XServer API

XServer API

XServer APIとは

ドメイン、メールアカウント、WordPress、データベースなどの各設定を、外部プログラムやAIエージェントから操作できるAPIです。

対象プラン 全プラン

APIのご利用方法

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

APIキーの発行手順

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

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

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

2.「APIキー追加」をクリック

「APIキー追加」ボタンをクリックし、必要事項を入力します。

「APIキー追加」をクリック

3.APIキーの確認

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

APIキーの確認

APIキーの削除手順

発行したAPIキーが不要になった場合や、外部への漏洩が疑われる場合は、以下の手順で速やかに削除を行ってください。

削除が必要なケース
  • APIを利用したプログラムの開発や運用が終了したとき
  • 連携していた外部サービスやAIエージェントの利用を止めるとき
  • APIキーを誤って公開設定の場所に保存してしまったとき（漏洩の疑い）
1.「APIキー管理」をクリック

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

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

2.「削除」をクリック

「APIキー一覧」にて、対象キーの右側にあるメニューボタン（3点リーダー）をクリックし、「削除」を選択します。

「削除」をクリック

3.「削除する」をクリック

確認画面で「削除する」をクリックすると、即座にそのキーは無効化されます。

「削除する」をクリック

APIキー作成上限

1サーバーアカウントあたりのAPIキー作成上限は以下の通りです。

プラン APIキー作成上限
全プラン 無制限

レート制限

XServer APIでは、APIリクエスト数にレート制限を設けています。
レート制限は、サーバーアカウント単位で適用されます。

プラン リクエスト/分 リクエスト/日 同時接続数
全プラン 300 100,000 20

APIの仕様

各APIの詳細な仕様については、APIリファレンスをご参照ください。

マニュアル一覧へ戻る