# XServer API > XServer API は、エックスサーバー・XServerビジネスのサーバーパネルで提供している主要機能を REST API で利用するためのインターフェースです。 ## Documentation - [Changelog](https://developer.xserver.ne.jp/changelog/): API / CLI / MCP の変更履歴 - [API Reference](https://developer.xserver.ne.jp/api/server/): サーバー管理 API の仕様・パラメータ・レスポンス例 - [Domain API Reference](https://developer.xserver.ne.jp/api/domain/): ドメイン管理 API の仕様・パラメータ・レスポンス例 - [WordPress Hosting API Reference](https://developer.xserver.ne.jp/api/wphosting/): XServer for WordPress API の仕様・パラメータ・レスポンス例 - [CLI Reference](https://developer.xserver.ne.jp/cli/server/): サーバー管理 CLI コマンドの仕様・使用例 - [OpenAPI Spec (JSON)](https://developer.xserver.ne.jp/api/server/openapi.json): サーバー管理 API の機械可読定義 - [Domain OpenAPI Spec (JSON)](https://developer.xserver.ne.jp/api/domain/openapi.json): ドメイン管理 API の機械可読定義 - [WordPress Hosting OpenAPI Spec (JSON)](https://developer.xserver.ne.jp/api/wphosting/openapi.json): XServer for WordPress API の機械可読定義 - [AI Skills](https://developer.xserver.ne.jp/ai/skills/): Cursor / Claude Code 等の AI コーディング環境用スキル ## Base URL https://api.xserver.ne.jp ## Authentication Bearer トークン(APIキー)を Authorization ヘッダーに付与。 ``` Authorization: Bearer xs_xxxxxxxxxxxx ``` APIキーはXServerアカウント(契約管理画面)の「APIキー管理」から発行。 ## Server API Endpoints ### APIキー情報 - GET /v1/me — 認証中のAPIキー情報を取得 - GET /v1/logs — API実行ログを取得 ### 新規お申し込み - GET /v1/server/plans — お申し込み可能なプラン・料金を取得 - POST /v1/server — サーバーを新規お申し込み - GET /v1/server/{servername}/signup-status — お申し込み状況を確認 ### サーバー契約管理 - GET /v1/server — サーバー契約の一覧を取得 - GET /v1/server/{servername}/memo — メモを取得 - PUT /v1/server/{servername}/memo — メモを更新 ### サーバー情報 - GET /v1/server/{servername}/server-info — サーバー情報を取得 - GET /v1/server/{servername}/server-info/usage — サーバー利用状況を取得 ### 自動バックアップの取得・復元 - GET /v1/server/{servername}/auto-backup/backup-dates — 選択可能なバックアップ日一覧を取得 - POST /v1/server/{servername}/auto-backup — 自動バックアップの取得または復元を申し込む - GET /v1/server/{servername}/auto-backup — 自動バックアップ申込履歴一覧を取得 - GET /v1/server/{servername}/auto-backup/{request_id} — 自動バックアップ申込履歴の詳細を取得 ### Cron設定 - GET /v1/server/{servername}/cron — Cron一覧を取得 - POST /v1/server/{servername}/cron — Cronを新規追加 - PUT /v1/server/{servername}/cron/{cron_id} — Cronを変更 - DELETE /v1/server/{servername}/cron/{cron_id} — Cronを削除 ### SSH設定 - GET /v1/server/{servername}/ssh — SSH設定を取得 - PUT /v1/server/{servername}/ssh — SSH設定を変更 - GET /v1/server/{servername}/ssh/key — SSH公開鍵一覧を取得 - POST /v1/server/{servername}/ssh/key — SSH公開鍵を登録 - PUT /v1/server/{servername}/ssh/key/{key_id} — SSH公開鍵を更新 - DELETE /v1/server/{servername}/ssh/key/{key_id} — SSH公開鍵を削除 ### リソースモニター - GET /v1/server/{servername}/resource-monitor — 指定日のCPU・メモリ・転送量時系列を取得 ### サイト転送設定 - GET /v1/server/{servername}/url-redirect — サイト転送設定一覧を取得 - POST /v1/server/{servername}/url-redirect — サイト転送設定を追加 - DELETE /v1/server/{servername}/url-redirect/{redirect_id} — サイト転送設定を削除 ### アクセス拒否設定 - GET /v1/server/{servername}/access-deny — アクセス拒否設定一覧を取得 - POST /v1/server/{servername}/access-deny — アクセス拒否設定を追加 - PUT /v1/server/{servername}/access-deny/{deny_id} — アクセス拒否設定のメモを更新 - DELETE /v1/server/{servername}/access-deny/{deny_id} — アクセス拒否設定を削除 ### XPageSpeed設定 - GET /v1/server/{servername}/xpagespeed — XPageSpeed設定一覧を取得 - PUT /v1/server/{servername}/xpagespeed/{domain} — XPageSpeedの最適化機能を変更 ### WordPress簡単インストール - GET /v1/server/{servername}/wp — WordPress一覧を取得 - POST /v1/server/{servername}/wp — WordPressを新規インストール - PUT /v1/server/{servername}/wp/{wp_id} — WordPress設定を変更 - DELETE /v1/server/{servername}/wp/{wp_id} — WordPressを削除 ### WordPressセキュリティ設定 - GET /v1/server/{servername}/wordpress-security — WordPressセキュリティ設定一覧を取得 - POST /v1/server/{servername}/wordpress-security — WordPressセキュリティ設定を更新 ### メールアカウント設定 - GET /v1/server/{servername}/mail — メールアカウント一覧を取得 - GET /v1/server/{servername}/mail/{mail_account} — メールアカウント詳細を取得 - POST /v1/server/{servername}/mail — メールアカウントを作成 - PUT /v1/server/{servername}/mail/{mail_account} — メールアカウントを変更 - DELETE /v1/server/{servername}/mail/{mail_account} — メールアカウントを削除 - GET /v1/server/{servername}/mail/{mail_account}/forwarding — メール転送設定を取得 - PUT /v1/server/{servername}/mail/{mail_account}/forwarding — メール転送設定を更新 ### 迷惑メールフィルタ - GET /v1/server/{servername}/spam-filter — 迷惑メールフィルタ設定を取得 - PUT /v1/server/{servername}/spam-filter/{domain} — 迷惑メールフィルタ設定を更新 - PUT /v1/server/{servername}/spam-filter/{domain}/dmarc-receiver — 受信側DMARC設定を更新 ### 自動応答設定 - GET /v1/server/{servername}/auto-reply — 自動応答設定一覧を取得 - GET /v1/server/{servername}/auto-reply/{mail_address} — 自動応答設定の詳細を取得 - POST /v1/server/{servername}/auto-reply — 自動応答設定を追加 - PUT /v1/server/{servername}/auto-reply/{mail_address} — 自動応答設定を更新 - DELETE /v1/server/{servername}/auto-reply/{mail_address} — 自動応答設定を削除 ### SMTP認証の国外アクセス制限 - GET /v1/server/{servername}/smtp-abroad-restriction — SMTP認証の国外アクセス制限設定を取得 - PUT /v1/server/{servername}/smtp-abroad-restriction/{domain} — SMTP認証の国外アクセス制限設定を更新 ### メール振り分け設定 - GET /v1/server/{servername}/mail-filter — メール振り分け設定一覧を取得 - POST /v1/server/{servername}/mail-filter — メール振り分け設定を追加 - DELETE /v1/server/{servername}/mail-filter/{filter_id} — メール振り分け設定を削除 ### DKIM設定 - GET /v1/server/{servername}/dkim — DKIM設定一覧を取得 - GET /v1/server/{servername}/dkim/{fqdn} — DKIM設定の詳細を取得 - PUT /v1/server/{servername}/dkim/{fqdn} — DKIM設定を更新 ### SPF設定 - GET /v1/server/{servername}/spf — SPF設定一覧を取得 - POST /v1/server/{servername}/spf — SPF設定を追加 - PUT /v1/server/{servername}/spf/{fqdn} — SPF設定を更新 - DELETE /v1/server/{servername}/spf/{fqdn} — SPF設定を削除 ### 送信側DMARC設定 - GET /v1/server/{servername}/dmarc — 送信側DMARC設定を取得 - PUT /v1/server/{servername}/dmarc/{domain} — 送信側DMARC設定を更新 ### FTPアカウント設定 - GET /v1/server/{servername}/ftp — FTPアカウント一覧を取得 - POST /v1/server/{servername}/ftp — FTPアカウントを追加 - PUT /v1/server/{servername}/ftp/{ftp_account} — FTPアカウントを変更 - DELETE /v1/server/{servername}/ftp/{ftp_account} — FTPアカウントを削除 ### MySQL設定 - GET /v1/server/{servername}/db — データベース一覧を取得 - POST /v1/server/{servername}/db — データベースを作成 - PUT /v1/server/{servername}/db/{db_name} — データベースのメモを更新 - DELETE /v1/server/{servername}/db/{db_name} — データベースを削除 - GET /v1/server/{servername}/db/user — MySQLユーザー一覧を取得 - POST /v1/server/{servername}/db/user — MySQLユーザーを作成 - PUT /v1/server/{servername}/db/user/{db_user} — MySQLユーザーを変更 - DELETE /v1/server/{servername}/db/user/{db_user} — MySQLユーザーを削除 - GET /v1/server/{servername}/db/user/{db_user}/grant — データベース権限を取得 - POST /v1/server/{servername}/db/user/{db_user}/grant — データベース権限を付与 - DELETE /v1/server/{servername}/db/user/{db_user}/grant — データベース権限を削除 ### MySQLバックアップの取得・復元 - GET /v1/server/{servername}/mysql-backup/databases — MySQLバックアップの状態を取得 - POST /v1/server/{servername}/mysql-backup — MySQLバックアップの取得または復元を申し込む - GET /v1/server/{servername}/mysql-backup — MySQLバックアップ申込履歴一覧を取得 - GET /v1/server/{servername}/mysql-backup/{request_id} — MySQLバックアップ申込履歴詳細を取得 ### PHPバージョン - GET /v1/server/{servername}/php-version — PHPバージョン設定を取得 - PUT /v1/server/{servername}/php-version/{domain} — PHPバージョンを変更 ### php.ini設定 - GET /v1/server/{servername}/php-ini — php.ini設定を取得 - PUT /v1/server/{servername}/php-ini/{domain} — php.ini設定を更新 - POST /v1/server/{servername}/php-ini/{domain}/reset — php.ini設定を初期値に戻す ### ドメイン設定 - GET /v1/server/{servername}/domain — ドメイン一覧を取得 - GET /v1/server/{servername}/domain/{domain} — ドメイン詳細を取得 - POST /v1/server/{servername}/domain — ドメインを追加 - PUT /v1/server/{servername}/domain/{domain} — ドメインのメモを更新 - DELETE /v1/server/{servername}/domain/{domain} — ドメインを削除 - POST /v1/server/{servername}/domain/{domain}/reset — ドメイン設定を初期化 ### サブドメイン設定 - GET /v1/server/{servername}/subdomain — サブドメイン一覧を取得 - POST /v1/server/{servername}/subdomain — サブドメインを追加 - PUT /v1/server/{servername}/subdomain/{subdomain} — サブドメインのメモを更新 - DELETE /v1/server/{servername}/subdomain/{subdomain} — サブドメインを削除 ### SSL設定 - GET /v1/server/{servername}/ssl — SSL設定一覧を取得 - POST /v1/server/{servername}/ssl — 無料SSLをインストール - DELETE /v1/server/{servername}/ssl/{common_name} — 無料SSLをアンインストール ### DNSレコード設定 - GET /v1/server/{servername}/dns — DNSレコード一覧を取得 - POST /v1/server/{servername}/dns — DNSレコードを追加 - PUT /v1/server/{servername}/dns/{dns_id} — DNSレコードを更新 - DELETE /v1/server/{servername}/dns/{dns_id} — DNSレコードを削除 ### アクセスログ - GET /v1/server/{servername}/access-log — アクセスログを取得 ### エラーログ - GET /v1/server/{servername}/error-log — エラーログを取得 ### Xアクセラレータ設定 - GET /v1/server/{servername}/x-accelerator — Xアクセラレータ設定一覧を取得 - PUT /v1/server/{servername}/x-accelerator/{domain} — Xアクセラレータ設定を変更 ### サーバーキャッシュ設定 - GET /v1/server/{servername}/server-cache — サーバーキャッシュ設定一覧を取得 - PUT /v1/server/{servername}/server-cache/{domain} — サーバーキャッシュ設定を変更 - DELETE /v1/server/{servername}/server-cache/{domain}/cache — サーバーキャッシュの内容を削除 ### ブラウザキャッシュ設定 - GET /v1/server/{servername}/browser-cache — ブラウザキャッシュ設定一覧を取得 - PUT /v1/server/{servername}/browser-cache/{domain} — ブラウザキャッシュ設定を変更 ### WAF設定 - GET /v1/server/{servername}/waf — WAF設定一覧を取得 - PUT /v1/server/{servername}/waf/{domain} — WAF設定を更新 ## Domain API Endpoints ### APIキー情報 - GET /v1/me — 認証中のAPIキー情報を取得 - GET /v1/logs — API実行ログを取得 ### ドメイン情報 - GET /v1/domain — ドメイン一覧を取得 - GET /v1/domain/{domain_name} — ドメイン詳細を取得 ### ネームサーバー設定 - GET /v1/domain/{domain_name}/nameservers — ネームサーバーを取得 - PUT /v1/domain/{domain_name}/nameservers — ネームサーバーを変更 ### DNSレコード設定 - GET /v1/domain/{domain_name}/dns — DNSレコード一覧を取得 - POST /v1/domain/{domain_name}/dns — DNSレコードを追加 - PUT /v1/domain/{domain_name}/dns/{dns_id} — DNSレコードを変更 - DELETE /v1/domain/{domain_name}/dns/{dns_id} — DNSレコードを削除 ### Whois情報設定 - GET /v1/domain/{domain_name}/whois — Whois情報を取得 - PUT /v1/domain/{domain_name}/whois — Whois情報を変更 ### レジストラロック設定 - GET /v1/domain/{domain_name}/registrar-lock — レジストラロック状態を取得 - PUT /v1/domain/{domain_name}/registrar-lock — レジストラロックを変更 ### 取得可能性・価格 - GET /v1/domain/check — 取得可能かを確認(空き確認+見積) - GET /v1/domain/pricing — TLD別価格一覧を取得 ### ドメイン取得 - POST /v1/domain — ドメインを取得(新規登録) ### ドメイン移管 - POST /v1/domain/{domain_name}/transfer — 他社からの移管を申請 ### 契約更新 - POST /v1/domain/{domain_name}/renew — 契約を更新(期限延長) ## WordPress Hosting API Endpoints ### APIキー情報 - GET /v1/me — 認証中のAPIキー情報を取得 - GET /v1/logs — API実行ログを取得 ### 新規お申し込み - GET /v1/wphosting/plans — お申し込み可能なプラン・料金を取得 - POST /v1/wphosting — 新規契約をお申し込み ### 契約管理 - GET /v1/wphosting — 契約の一覧を取得 - GET /v1/wphosting/{contract_id}/memo — メモを取得 - PUT /v1/wphosting/{contract_id}/memo — メモを更新 ### サイト情報 - GET /v1/wphosting/{contract_id}/sites — サイト一覧を取得 - GET /v1/wphosting/{contract_id}/sites/{servername} — サイト詳細を取得 - GET /v1/wphosting/{contract_id}/usage — 利用状況を取得 ### サイト作成・削除 - POST /v1/wphosting/{contract_id}/sites — サイトを作成 - DELETE /v1/wphosting/{contract_id}/sites/{servername} — サイトを削除 ### ステージング環境 - POST /v1/wphosting/{contract_id}/sites/{servername}/staging — ステージング環境を作成 ### バックアップ - GET /v1/wphosting/{contract_id}/sites/{servername}/backups — 手動バックアップ一覧を取得 - POST /v1/wphosting/{contract_id}/sites/{servername}/backups — 手動バックアップを作成 - POST /v1/wphosting/{contract_id}/sites/{servername}/backups/{backup_id}/restore — 手動バックアップから復元 - GET /v1/wphosting/{contract_id}/sites/{servername}/backups/restore-history — 復元履歴を取得 - DELETE /v1/wphosting/{contract_id}/sites/{servername}/backups/{backup_id} — 手動バックアップを削除 ### WordPressバージョン - GET /v1/wphosting/{contract_id}/sites/{servername}/wordpress — WordPressバージョン情報を取得 - PUT /v1/wphosting/{contract_id}/sites/{servername}/wordpress — WordPressバージョンの設定を変更 - POST /v1/wphosting/{contract_id}/sites/{servername}/wordpress/update — WordPress本体を更新 ### メンテナンスモード - GET /v1/wphosting/{contract_id}/sites/{servername}/maintenance-mode — メンテナンスモードを取得 - PUT /v1/wphosting/{contract_id}/sites/{servername}/maintenance-mode — メンテナンスモードを切替 ### プラグイン - GET /v1/wphosting/{contract_id}/sites/{servername}/plugins — プラグイン一覧を取得 - POST /v1/wphosting/{contract_id}/sites/{servername}/plugins — プラグインをインストール - PUT /v1/wphosting/{contract_id}/sites/{servername}/plugins/{plugin} — プラグインの状態を変更 - POST /v1/wphosting/{contract_id}/sites/{servername}/plugins/{plugin}/update — プラグインを更新 - DELETE /v1/wphosting/{contract_id}/sites/{servername}/plugins/{plugin} — プラグインを削除 ### テーマ - GET /v1/wphosting/{contract_id}/sites/{servername}/themes — テーマ一覧を取得 - POST /v1/wphosting/{contract_id}/sites/{servername}/themes — テーマをインストール - PUT /v1/wphosting/{contract_id}/sites/{servername}/themes/{theme} — テーマの状態を変更 - POST /v1/wphosting/{contract_id}/sites/{servername}/themes/{theme}/update — テーマを更新 - DELETE /v1/wphosting/{contract_id}/sites/{servername}/themes/{theme} — テーマを削除 ### ドメイン設定 - GET /v1/wphosting/{contract_id}/sites/{servername}/domains — ドメイン設定一覧を取得 - POST /v1/wphosting/{contract_id}/sites/{servername}/domains — ドメイン設定を追加 - POST /v1/wphosting/{contract_id}/sites/{servername}/domains/{domain}/verify — ドメインの所有者確認を実行 - DELETE /v1/wphosting/{contract_id}/sites/{servername}/domains/{domain} — ドメイン設定を削除 - PUT /v1/wphosting/{contract_id}/sites/{servername}/site-url — サイトURLを変更 ### DNSレコード設定 - GET /v1/wphosting/{contract_id}/sites/{servername}/domains/{domain}/dns — DNSレコード一覧を取得 - POST /v1/wphosting/{contract_id}/sites/{servername}/domains/{domain}/dns — DNSレコードを追加 - PUT /v1/wphosting/{contract_id}/sites/{servername}/domains/{domain}/dns/{dns_id} — DNSレコードを変更 - DELETE /v1/wphosting/{contract_id}/sites/{servername}/domains/{domain}/dns/{dns_id} — DNSレコードを削除 ### PHPバージョン設定 - GET /v1/wphosting/{contract_id}/sites/{servername}/php-version — PHPバージョンを取得 - PUT /v1/wphosting/{contract_id}/sites/{servername}/php-version — PHPバージョンを変更 ### ログ - GET /v1/wphosting/{contract_id}/sites/{servername}/access-log — アクセスログを取得 - GET /v1/wphosting/{contract_id}/sites/{servername}/error-log — エラーログを取得 ### Cron設定 - GET /v1/wphosting/{contract_id}/sites/{servername}/cron — Cron一覧を取得 - POST /v1/wphosting/{contract_id}/sites/{servername}/cron — Cronを新規追加 - PUT /v1/wphosting/{contract_id}/sites/{servername}/cron/{cron_id} — Cronを変更 - DELETE /v1/wphosting/{contract_id}/sites/{servername}/cron/{cron_id} — Cronを削除 ### SSH設定 - GET /v1/wphosting/{contract_id}/sites/{servername}/ssh — SSH設定を取得 - PUT /v1/wphosting/{contract_id}/sites/{servername}/ssh — SSH設定を変更 - GET /v1/wphosting/{contract_id}/sites/{servername}/ssh/key — SSH公開鍵一覧を取得 - POST /v1/wphosting/{contract_id}/sites/{servername}/ssh/key — SSH公開鍵を登録 - PUT /v1/wphosting/{contract_id}/sites/{servername}/ssh/key/{key_id} — SSH公開鍵を更新 - DELETE /v1/wphosting/{contract_id}/sites/{servername}/ssh/key/{key_id} — SSH公開鍵を削除 ### WordPressユーザー - GET /v1/wphosting/{contract_id}/sites/{servername}/wp-users — WordPressユーザー一覧を取得 - GET /v1/wphosting/{contract_id}/sites/{servername}/wp-users/{user_id} — WordPressユーザー詳細を取得 - POST /v1/wphosting/{contract_id}/sites/{servername}/wp-users — WordPressユーザーを作成 - PUT /v1/wphosting/{contract_id}/sites/{servername}/wp-users/{user_id} — WordPressユーザーを更新 - DELETE /v1/wphosting/{contract_id}/sites/{servername}/wp-users/{user_id} — WordPressユーザーを削除 - GET /v1/wphosting/{contract_id}/sites/{servername}/wp-users/roles — 権限グループ一覧を取得 ### WordPressセキュリティ - GET /v1/wphosting/{contract_id}/sites/{servername}/security — セキュリティ設定一覧を取得 - PUT /v1/wphosting/{contract_id}/sites/{servername}/security/{key} — セキュリティ設定を変更