XServer API
XServer APIとは
サーバー管理やドメイン管理など各サービスの機能を、外部プログラムやAIエージェントから実行できるREST APIです。
1つのAPIキーで複数サーバー、複数サービスを操作できます。
XServer for WordPressでは、サイト作成、バックアップ、WordPressのユーザー・プラグイン・テーマの管理、セキュリティなどの各設定を操作できます。
| 対象プラン | 全プラン |
|---|
APIのご利用方法
XServer APIを利用するには、まずAPIキーを発行する必要があります。
APIキーはXServerアカウントから発行・管理が行えます。
APIキーの発行手順
1.「APIキー管理」をクリック
XServerアカウントへログインし、サービスメニューの「APIキー管理」をクリックします。
2.「APIキー追加」をクリック
「APIキー追加」ボタンをクリックします。
3. 必要事項を入力し、「確認画面へ進む」をクリック
各項目を設定し、「確認画面へ進む」をクリックしてください。
API キーの基本設定
APIキー名を入力し、有効期限を選択します。
必要に応じてアクセスを許可するIPアドレスが指定できます。
利用するサービスと権限
APIを利用する対象契約、サイトを選択します。
操作権限は「すべての操作」「読み取り専用」「カスタム」から選択できます。「カスタム」は操作項目ごとに権限が選択できます。
※APIを提供している契約中のサービスもあわせて設定できます。
4. APIキーの確認
発行が完了すると、APIキーが表示されます。APIキーは xs_ で始まる文字列です。
APIキーの削除手順
発行したAPIキーが不要になった場合や、外部への漏洩が疑われる場合は、以下の手順で速やかに削除を行ってください。
- 削除が必要なケース
-
- APIを利用したプログラムの開発や運用が終了したとき
- 連携していた外部サービスやAIエージェントの利用を止めるとき
- APIキーを誤って公開設定の場所に保存してしまったとき（漏洩の疑い）
1.「APIキー管理」をクリック
XServerアカウントへログインし、サービスメニューの「APIキー管理」をクリックします。
2.「削除」をクリック
「APIキー一覧」にて、対象キーの右側にあるメニューボタン（3点リーダー）をクリックし、「削除」を選択します。
3.「削除する」をクリック
確認画面で「削除する」をクリックすると、即座にそのキーは無効化されます。
レート制限
XServer APIでは、APIリクエスト数にレート制限を設けています。
レート制限は、契約単位で適用されます。
| プラン | リクエスト/分 | リクエスト/日 | 同時接続数 |
|---|---|---|---|
| ベーシック | 60 | 10,000 | 5 |
| スタンダード | 120 | 30,000 | 10 |
| プレミアム | 300 | 100,000 | 20 |
| エンタープライズ | 300 | 100,000 | 20 |
APIの仕様
各APIの詳細な仕様については、APIリファレンスをご参照ください。
