XServer CLI リファレンス — サーバー管理
XServer CLI は、XServer API をコマンドラインから操作するための公式 CLI ツールです。サーバーの設定変更・情報取得をターミナルから直接実行でき、運用の自動化やスクリプト連携を可能にします。
このリファレンスでは xserver server 配下のサーバー管理コマンドを網羅しています。
CLIの変更履歴は 更新履歴 を参照してください。
インストール
Node.js(v18 以上)がインストールされた環境で、npm からグローバルインストールしてください。
npm install -g xserver-cli
インストール後は、ターミナルのどのディレクトリからでも xserver コマンドが利用可能です。
インストールせずに即時実行することもできます。
npx xserver-cli server info
バージョン確認
認証設定
APIを利用するには、事前にAPIキーを設定する必要があります。APIキーはXServerアカウント画面の「APIキー管理」から発行できます。
APIキーの発行手順については、下記マニュアルをご参照ください。
xserver auth login
対話形式でAPIキーを設定します。APIキーの入力はセキュリティのためマスク表示(***)され、ログイン時に GET /v1/me の services.server からサーバー名(初期ドメイン)を解決します。
APIキーのサーバー対象設定に応じて、サーバー名の扱いは次のとおりです。
| APIキーのサーバー対象 | 挙動 |
1台(target_mode: selected、targets が1件) | サーバー名を自動検出してプロファイルに保存 |
複数台(targets が2件以上) | 対話形式では選択プロンプトを表示。非対話(CI/CD 等)では --servername の指定が必要 |
「すべてのサーバー」(target_mode: all) | 警告を表示。servername 未固定のままプロファイルを保存 |
| サーバー区分なし | 警告を表示。servername 未固定のままプロファイルを保存 |
xserver auth login
# ✔ APIキーを入力: ****
# 認証情報を検証中...
# ✓ 認証に成功しました
# サーバー名を自動検出しました: xs123456.xsrv.jp
# ✓ プロファイル "default" を保存しました
xserver auth login
# ✔ APIキーを入力: ****
# 認証情報を検証中...
# ✓ 認証に成功しました
# このAPIキーは対象サーバーが固定されていません(「すべてのサーバー」等)。
# サーバー系コマンドでは --servername で対象を指定してください。
# 例: xserver server --servername <サーバーID> info
# ✓ プロファイル "default" を保存しました
オプションで非対話的に設定することも可能です(CI/CD 環境向け)。対象サーバーが1台のキーであれば、通常は --servername を省略できます。
xserver auth login --api-key YOUR_API_KEY
--servername は、対象サーバーが複数あるキー(非対話環境)、「すべてのサーバー」等で servername が未固定のキー、または自動検出結果を上書きしたい場合に指定してください。
xserver auth login --api-key YOUR_API_KEY --servername xs123456.xsrv.jp
プロファイル
複数のAPIキーを名前付きプロファイルとして保存し、切り替えて使うことができます。
xserver auth login --profile staging
xserver --profile staging server info
xserver --format json auth profiles
設定ファイルは ~/.config/xserver-cli/config.json に保存されます。
環境変数
環境変数でもAPIキーとサーバー名を指定できます。CI/CD パイプラインでの利用に適しています。
| 環境変数 | 説明 |
XSERVER_API_KEY | APIキー |
XSERVER_SERVERNAME | サーバー名(初期ドメイン) |
XSERVER_API_KEY=YOUR_API_KEY XSERVER_SERVERNAME=xs123456.xsrv.jp \
xserver server cron list
認証の優先順位
| 優先度 | 方式 | 用途 |
| 1(最優先) | 環境変数 | CI/CD、スクリプト |
| 2 | プロファイル設定ファイル | 通常利用(推奨) |
※環境変数はXSERVER_API_KEYが設定されている場合のみ使用されます。
xserver auth status
現在の認証状態を確認します。servername が未固定のプロファイルは サーバー名: 未固定(サーバー系コマンドでは --servername で指定) と表示されます。
xserver --format json auth status
グローバルオプション
すべてのコマンドで共通して利用できるオプションです。
| オプション | 説明 | デフォルト |
--format <format> | 出力形式(table または json) | table |
--profile <name> | 使用するプロファイル名 | default |
-y, --yes | 削除・初期化などの確認プロンプトをスキップ | — |
-V, --version | バージョン番号を表示 | — |
-h, --help | ヘルプを表示 | — |
server コマンドオプション
xserver server 配下のコマンドで共通して利用できるオプションです。
| オプション | 説明 |
--servername <name> | サーバー名(初期ドメイン)を一時的に上書きします。プロファイルに保存されたサーバー名より優先されます。 |
--servername にはサーバー契約時に自動で付与される初期ドメインを指定してください。初期ドメインは以下の形式です。
| サービス | 初期ドメインの形式 |
| エックスサーバー | サーバーID.xsrv.jp |
| XServerビジネス | サーバーID.xbiz.jp |
xserver server --servername xs123456.xsrv.jp cron list
サーバー名の優先順位
| 優先度 | 指定方法 |
| 1(最優先) | --servername オプション |
| 2 | 環境変数 XSERVER_SERVERNAME |
| 3 | プロファイルに保存されたサーバー名 |
※環境変数はXSERVER_API_KEYが設定されている場合のみ使用されます。
出力形式
テーブル形式(デフォルト)
人間が読みやすい形式で出力します。
JSON形式
プログラムからの利用やパイプラインでの処理に適した形式です。jq コマンドと組み合わせて使うこともできます。
xserver --format json server cron list
xserver --format json server cron list | jq ".crons[].command"
レート制限エラー
APIの利用上限を超えた場合、CLIは RATE_LIMIT_EXCEEDED エラーを表示して終了します。HTTPレスポンスに Retry-After ヘッダーが含まれる場合は、その秒数を目安に待ってから再実行してください。
通常の分あたり・日あたり・同時リクエスト数の上限に加えて、認証失敗が短時間に続いた場合はIPアドレス単位で一時的にブロックされます。APIキーや環境変数の設定を確認してから再試行してください。
APIキー情報
現在認証に使用しているAPIキーの情報を返します。有効期限・紐づくサーバー名・権限種別を確認できます。
使用例
サーバー情報
サーバーのスペック・ソフトウェアバージョン・ネームサーバーなどの基本情報を返します。サーバーパネルの「サーバー情報」画面に相当します。
使用例
xserver --format json server info
ディスク使用量・ファイル数・各種設定件数を返します。サーバーパネルのトップページに表示される利用状況に相当します。ディスク容量はサーバーパネルと同じ基準(MB を 1000 で除算した小数2桁)で GB 換算した値を返します。
使用例
自動バックアップの取得・復元
取得・復元の申込(create)で指定できる backup_date の候補を返します。通常14日分ですが、サーバーによっては7日分のみの場合があります。
使用例
xserver server auto-backup backup-dates
指定したバックアップ日のデータ取得(--operation-type fetch)または復元(--operation-type restore)を非同期で申し込みます。進捗は show をポーリングしてください。restore はサーバー上のデータを上書きする破壊的操作であり、取り消しできません。確認プロンプトが表示されます(-y でスキップ可能)。fetch 完了後は FTP 等で取得してください。scope=selected のときは --domain-elements の指定が必須です。
オプション
| オプション | 必須 | 説明 |
--backup-date <date> | 必須 | 対象バックアップ日(Y-m-d。backup-dates で available=true の日) |
--operation-type <type> | 必須 | 処理種別。fetch: データ取得 / restore: 復元 |
--scope <scope> | 必須 | 処理方法。all: サーバー領域全体 / selected: 対象ドメイン・ディレクトリを指定 |
--domain-elements <value> | 任意 | scope=selected のとき必須。形式: ドメイン=種別1,種別2(例: example.com=web,setting)。種別: web / setting / mail。繰り返し指定可(最大10ドメイン) |
-y, --yes | 任意 | 確認プロンプトをスキップ(restore 時) |
使用例
xserver server auto-backup create --backup-date 2026-06-01 --operation-type fetch --scope all
xserver server auto-backup create --backup-date 2026-06-01 --operation-type fetch --scope selected --domain-elements example.com=web,setting
xserver server auto-backup create --backup-date 2026-06-01 --operation-type fetch --scope selected --domain-elements example.com=web,setting --domain-elements other.com=mail
xserver server auto-backup create --backup-date 2026-06-01 --operation-type restore --scope selected --domain-elements example.com=web --domain-elements other.com=web,setting
xserver server auto-backup create --backup-date 2026-06-01 --operation-type restore --scope all
過去の取得・復元申込の履歴を返します。
使用例
xserver server auto-backup list
指定した申込の詳細を返します。申込後の進捗確認に使用してください。
引数
使用例
xserver server auto-backup show 12345
Cron設定
登録済みのCron設定を一覧で返します。各要素の id は PUT/DELETE で指定するハッシュIDです。
使用例
新しいCron設定を追加します。レスポンスの id は後続の PUT・DELETE で使用します。
オプション
| オプション | 必須 | 説明 |
--minute <value> | 必須 | 分(例: */5, 0, *) |
--hour <value> | 必須 | 時(例: *, 3, 0-6) |
--command <value> | 必須 | 実行コマンド |
--day <value> | 任意 | 日(デフォルト: *) |
--month <value> | 任意 | 月(デフォルト: *) |
--weekday <value> | 任意 | 曜日(デフォルト: *) |
--comment <value> | 任意 | コメント |
使用例
xserver server cron add \
--minute 0 --hour 0 \
--command "/usr/bin/php /home/user/batch.php"
xserver server cron add \
--minute "*/5" --hour "*" \
--command "/home/user/check.sh" \
--comment "定期チェック"
既存のCron設定を変更します。指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります。スケジュール・コマンド・コメントなどの内容を変更すると id が変わります。後続の update / delete ではレスポンスの新しい id を使用してください。
引数
オプション
| オプション | 必須 | 説明 |
--minute <value> | 任意 | 分 |
--hour <value> | 任意 | 時 |
--day <value> | 任意 | 日 |
--month <value> | 任意 | 月 |
--weekday <value> | 任意 | 曜日 |
--command <value> | 任意 | 実行コマンド |
--comment <value> | 任意 | コメント |
--enabled <value> | 任意 | 有効/無効(true / false) |
使用例
xserver server cron update 123 --enabled false
xserver server cron update 123 --minute 30 --hour 3
指定したCronジョブを削除します。
引数
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server cron delete 123
SSH設定
SSH接続の有効/無効、国外アクセス制限の状態、接続情報、登録済み公開鍵数を返します。
使用例
SSH接続の有効/無効、国外アクセス制限の有効/無効を変更します。変更したいフィールドのみ送信してください。SSH公開鍵の登録・更新・削除の結果によっては、SSH接続および国外アクセス制限が自動で有効/無効される場合があります。
オプション
| オプション | 必須 | 説明 |
--ssh-enabled <value> | 任意 | SSH接続の有効/無効(true/false) |
--abroad-access-restriction <value> | 任意 | 国外アクセス制限の有効/無効(true/false) |
使用例
xserver server ssh update --ssh-enabled true
xserver server ssh update --abroad-access-restriction false
登録済みSSH公開鍵の一覧を返します。
使用例
xserver server ssh key list
公開鍵を手動で登録するか、--generate でサーバー側で鍵ペアを自動生成します。自動生成時は秘密鍵がレスポンスに含まれます(発行時の1回のみ)。公開鍵が最初に登録される場合は、SSH接続および国外アクセス制限が自動で有効になります。
オプション
| オプション | 必須 | 説明 |
--label <value> | 必須 | ラベル |
--public-key <key> | 任意 | 公開鍵(手動登録時。OpenSSH形式) |
--generate | 任意 | サーバー側で鍵ペアを自動生成 |
--passphrase <value> | 任意 | パスフレーズ(自動生成時。6〜32文字) |
使用例
xserver server ssh key add \
--label "デプロイ用" \
--public-key "ssh-ed25519 AAAA..."
xserver server ssh key add --label "CI用" --generate
xserver server ssh key add --label "本番用" --generate --passphrase "MyPass123"
ラベルやステータス(on/off)を変更します。変更したいフィールドのみ送信してください。ステータスの変更により、公開鍵が有効になる一つ目の場合は SSH接続および国外アクセス制限が自動で有効になります。有効な公開鍵が0件になる場合は SSH接続および国外アクセス制限が自動で無効になります。
引数
オプション
| オプション | 必須 | 説明 |
--label <value> | 任意 | ラベル |
--status <value> | 任意 | ステータス(on/off) |
使用例
xserver server ssh key update 1 --label "新しいラベル"
xserver server ssh key update 1 --status off
指定したSSH公開鍵を削除します。公開鍵がすべて削除されて有効な公開鍵が0件になる場合は、SSH接続および国外アクセス制限が自動で無効になります。
引数
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server ssh key delete 1
リソースモニター
指定日の CPU・メモリ・転送量を5分刻みの時系列で返します。--date は当日を含む直近1か月以内のみ指定できます。出力データ量が多いため、--format json の使用を推奨します。※ 本機能は XServerビジネス(全プラン)では利用できません。
オプション
| オプション | 必須 | 説明 |
--date <date> | 必須 | 対象日(Y-m-d または Ymd。当日含む直近1か月) |
使用例
xserver server resource-monitor get --date 20260609 --format json
サイト転送設定
サイト転送設定の一覧を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server url-redirect list
xserver server url-redirect list --domain example.com
サイト転送設定を追加します。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 必須 | 契約ドメイン(最大253文字。日本語ドメインの場合はPunycodeで指定) |
--from-host <host> | 必須 | 転送元ホスト(FQDN。契約ドメインまたはサブドメイン) |
--from-path <path> | 任意 | 転送元パス(英数字・記号のみ。省略時は /) |
--redirect-to-url <url> | 必須 | 転送先URL(http または https) |
--status-code <code> | 必須 | リダイレクト時のステータスコード(301: 恒久的 / 302: 一時的) |
使用例
xserver server url-redirect add \
--domain example.com \
--from-host example.com \
--from-path /old-path \
--redirect-to-url https://example.com/new-path \
--status-code 301
xserver server url-redirect add \
--domain example.com \
--from-host www.example.com \
--redirect-to-url https://example.com/ \
--status-code 301
指定したサイト転送設定を削除します。確認プロンプトが表示されます(-y でスキップ可能)。
引数
| 引数 | 説明 |
redirectId | サイト転送設定のID |
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server url-redirect delete a1b2c3d4e5f67890
xserver server url-redirect delete a1b2c3d4e5f67890 -y
アクセス拒否設定
アクセス拒否設定の一覧を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。サーバーキャッシュが有効なドメインでは、拒否設定が反映されない場合があります。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server access-deny list
xserver server access-deny list --domain example.com
指定ドメインにアクセス拒否設定を追加します。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 必須 | 契約ドメイン(最大253文字。日本語ドメインの場合はPunycodeで指定) |
--ip-address <address> | 必須 | 拒否IPアドレス・ホスト(IPv4 / CIDR / 部分IP / ホスト名) |
--memo <memo> | 任意 | メモ(最大500文字) |
使用例
xserver server access-deny add --domain example.com --ip-address 192.168.1.1 --memo 社内テスト用
xserver server access-deny add --domain example.com --ip-address 203.0.113.0/24
指定したアクセス拒否設定のメモのみを更新します。
引数
| 引数 | 説明 |
denyId | アクセス拒否設定のID(list または add で得られる id) |
オプション
| オプション | 必須 | 説明 |
--memo <memo> | 必須 | メモ(最大500文字。空文字でクリア) |
使用例
xserver server access-deny update a1b2c3d4e5f67890 --memo 更新メモ
xserver server access-deny update a1b2c3d4e5f67890 --memo ""
指定したアクセス拒否設定を削除します。確認プロンプトが表示されます(-y でスキップ可能)。
引数
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server access-deny delete a1b2c3d4e5f67890
xserver server access-deny delete a1b2c3d4e5f67890 -y
XPageSpeed設定
契約ドメインごとの XPageSpeed 設定を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。※ 本機能は XServerビジネス(全プラン)、エックスサーバー(旧X2スタンダードプラン / 旧X2アドバンスドプラン)では利用できません。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server xpagespeed list
xserver server xpagespeed list --domain example.com
指定ドメインの XPageSpeed 最適化機能を1件ずつ変更します。変更する機能のオプションを1つだけ指定してください。更新用オプションを1つも指定しないとエラーになります。※ 本機能は XServerビジネス(全プラン)、エックスサーバー(旧X2スタンダードプラン / 旧X2アドバンスドプラン)では利用できません。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
--xoptimize-images <value> | 任意 | 画像最適化(true/false または 1/0) |
--lazyload-images <value> | 任意 | 画像遅延読み込み(true/false または 1/0) |
--xoptimize-css <value> | 任意 | CSS最適化(true/false または 1/0) |
--lazyload-css <value> | 任意 | CSS遅延読み込み(true/false または 1/0) |
--xoptimize-javascript <value> | 任意 | JavaScript最適化(true/false または 1/0) |
--lazyload-javascript <value> | 任意 | JavaScript遅延読み込み(true/false または 1/0) |
使用例
xserver server xpagespeed update example.com --xoptimize-images true
xserver server xpagespeed update example.com --lazyload-images false
WordPress簡単インストール
簡単インストールでインストール済みのWordPress一覧を返します。--domain を指定すると、そのドメインのインストールのみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | ドメインで絞り込み |
使用例
xserver server wp list --domain example.com
指定URLにWordPressを簡単インストールします。URLにはドメインまたはサブドメインを指定でき、パス付きも可能です。スキーム(https:// 等)は省略できます。
オプション
| オプション | 必須 | 説明 |
--url <url> | 必須 | インストール先URL(例: example.com/blog) |
--title <title> | 必須 | サイトタイトル |
--admin-username <username> | 必須 | 管理者ユーザー名 |
--admin-password <password> | 必須 | 管理者パスワード |
--admin-email <email> | 必須 | 管理者メールアドレス |
--memo <value> | 任意 | メモ |
使用例
xserver server wp add \
--url example.com/blog \
--title "My Blog" \
--admin-username admin \
--admin-password "SecurePass123!" \
--admin-email admin@example.com
WordPressの設定を変更します。現在変更可能な項目はメモのみです。
引数
| 引数 | 説明 |
wpId | 更新対象のWordPress ID |
オプション
| オプション | 必須 | 説明 |
--memo <value> | 任意 | メモ |
使用例
xserver server wp update 456 --memo "本番サイト"
WordPressをアンインストールします。関連するデータベース・ユーザー・Cronの削除はオプションで制御できます。デフォルトでは --delete-db / --delete-cron は true ですが、--delete-db-user は false(DBユーザーは残す)である点に注意してください。
引数
| 引数 | 説明 |
wpId | 削除対象のWordPress ID |
オプション
| オプション | 必須 | 説明 |
--delete-db <value> | 任意 | 関連するMySQLデータベースも削除するか(デフォルト: true) |
--delete-db-user <value> | 任意 | 関連するMySQLユーザーも削除するか(デフォルト: false) |
--delete-cron <value> | 任意 | キャッシュ自動削除Cronも削除するか(デフォルト: true) |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server wp delete 456
xserver server wp delete 456 --delete-db-user true
WordPressセキュリティ設定
契約ドメインごとの WordPress セキュリティ設定(コメント制限・ログイン試行回数制限・国外アクセス制限・IPアドレス制限)を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server wordpress-security get
xserver server wordpress-security get --domain example.com
指定ドメインの WordPress セキュリティ設定を更新します。指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。更新用オプションを1つも指定しないとエラーになります。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
--comment-restriction-bulk-post-enabled <value> | 任意 | 単一ユーザーからの大量投稿の有効/無効(true/false または 1/0) |
--comment-restriction-foreign-post-enabled <value> | 任意 | 国外からの投稿の有効/無効(true/false または 1/0) |
--login-attempt-limit-enabled <value> | 任意 | ログイン試行回数制限の有効/無効(true/false または 1/0) |
--foreign-ip-dashboard-enabled <value> | 任意 | ダッシュボード アクセス制限の有効/無効 |
--foreign-ip-dashboard-allowed-ips <addresses> | 任意 | ダッシュボード アクセス制限のホワイトリスト(カンマ区切り IPv4 またはワイルドカード。通常はクォート不要。空にする場合のみ "" を指定) |
--foreign-ip-xml-rpc-api-enabled <value> | 任意 | XML-RPC API アクセス制限の有効/無効 |
--foreign-ip-xml-rpc-api-allowed-ips <addresses> | 任意 | XML-RPC API アクセス制限のホワイトリスト(カンマ区切り。通常はクォート不要。空にする場合のみ "" を指定) |
--foreign-ip-rest-api-enabled <value> | 任意 | REST API アクセス制限の有効/無効 |
--foreign-ip-rest-api-allowed-ips <addresses> | 任意 | REST API アクセス制限のホワイトリスト(カンマ区切り。通常はクォート不要。空にする場合のみ "" を指定) |
--foreign-ip-wlwmanifest-enabled <value> | 任意 | wlwmanifest.xml アクセス制限の有効/無効 |
--foreign-ip-wlwmanifest-allowed-ips <addresses> | 任意 | wlwmanifest.xml アクセス制限のホワイトリスト(カンマ区切り。通常はクォート不要。空にする場合のみ "" を指定) |
--ip-restriction-enabled <value> | 任意 | IPアドレス制限(ダッシュボード)の有効/無効 ※本設定が有効な場合、国外アクセス制限のダッシュボード アクセス制限より本設定が優先されます。有効化するには許可IPアドレスを1件以上登録してください。 |
--ip-restriction-allowed-ips <addresses> | 任意 | IPアドレス制限のホワイトリスト(カンマ区切り IPv4 または CIDR。通常はクォート不要。空にする場合のみ "" を指定) |
使用例
xserver server wordpress-security update example.com --login-attempt-limit-enabled true
xserver server wordpress-security update example.com --foreign-ip-dashboard-enabled true --foreign-ip-dashboard-allowed-ips 203.0.113.10
xserver server wordpress-security update example.com --foreign-ip-dashboard-allowed-ips 203.0.113.10,198.51.100.1
xserver server wordpress-security update example.com --foreign-ip-dashboard-allowed-ips ""
メールアカウント設定
サーバーに登録済みのメールアカウントを一覧で返します。--domain を指定すると、そのドメインのアカウントのみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server mail list --domain example.com
指定したメールアカウントの詳細情報(容量・使用量を含む)を返します。
引数
| 引数 | 説明 |
mailAccount | メールアカウント(例: user@example.com)。URLエンコードすること |
使用例
xserver server mail get info@example.com
メールアカウントを作成します。作成時にドメイン所有権の確認(TXTレコード検証)が自動で実施されます。詳細は「ドメイン所有権確認」を参照してください。
引数
オプション
| オプション | 必須 | 説明 |
--password <password> | 必須 | パスワード(8文字以上) |
--quota-mb <mb> | 任意 | 容量(MB) 1-20000 |
--memo <value> | 任意 | メモ |
使用例
xserver server mail add info@example.com \
--password "SecurePass123!"
xserver server mail add info@example.com \
--password "SecurePass123!" \
--quota-mb 2000
指定したメールアカウントを変更します。
引数
| 引数 | 説明 |
mailAccount | メールアカウント(例: user@example.com)。URLエンコードすること |
オプション
| オプション | 必須 | 説明 |
--password <password> | 任意 | パスワード(8文字以上)。指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります |
--quota-mb <mb> | 任意 | 容量(MB) 1-20000 |
--memo <value> | 任意 | メモ |
使用例
xserver server mail update info@example.com \
--password "NewPass456!"
指定したメールアカウントを削除します。
引数
| 引数 | 説明 |
mailAccount | メールアカウント(例: user@example.com)。URLエンコードすること |
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server mail delete info@example.com
指定したメールアカウントの転送設定を返します。
引数
| 引数 | 説明 |
mailAccount | メールアカウント(例: user@example.com)。URLエンコードすること |
使用例
xserver server mail forwarding-get info@example.com
指定したメールアカウントのメール転送設定を更新します。更新用オプションを1つも指定しないとエラーになります。
引数
| 引数 | 説明 |
mailAccount | メールアカウント(例: user@example.com)。URLエンコードすること |
オプション
| オプション | 必須 | 説明 |
--forwarding-addresses <addresses> | 任意 | 転送先メールアドレス(カンマ区切り。上書きで設定。空文字でクリア)。指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます |
--keep-in-mailbox <value> | 任意 | 転送後もメールボックスに残すか(true/false または 1/0) |
使用例
xserver server mail forwarding-update info@example.com \
--forwarding-addresses "user1@gmail.com,user2@gmail.com"
xserver server mail forwarding-update info@example.com \
--keep-in-mailbox true
迷惑メールフィルタ
指定したドメインの迷惑メールフィルタ設定を返します。--domain を指定すると、そのドメインの設定のみを取得できます。迷惑メールフィルタが標準スパムフィルタ(standard)のときは、標準スパムフィルタ判定基準・日本語を含まない件名に対して判定を厳しくする・HTMLメールに対して判定を厳しくするを表示します。それ以外(off / cloudmark_authority)のときは表示されません。※ filter_type の 高性能スパムフィルタ「Cloudmark Authority」は、エックスサーバー・XServerビジネスでのみ指定・利用できます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server spam-filter list
xserver server spam-filter list --domain example.com
指定したドメインの迷惑メールフィルタ設定を更新します。迷惑メールフィルタを標準スパムフィルタ(standard)に指定するときは、標準スパムフィルタ判定基準・日本語を含まない件名に対して判定を厳しくする・HTMLメールに対して判定を厳しくするを指定してください。更新用オプションを1つも指定しないとエラーになります。※ filter_type の 高性能スパムフィルタ「Cloudmark Authority」は、エックスサーバー・XServerビジネスでのみ指定・利用できます。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
--filter-type <value> | 任意 | 迷惑メールフィルタ(空文字不可)。off: OFF / standard: 標準スパムフィルタ / cloudmark_authority: 高性能スパムフィルタ「Cloudmark Authority」。 |
--detection-action <action> | 任意 | 検知時の処理(空文字不可)。inbox: 受信箱へ配信する / spam: 迷惑メールフォルダへ移動する / trash: ゴミ箱へ移動する / delete: 削除する |
--spam-level <level> | 任意 | 標準スパムフィルタ判定基準(空文字不可)。standard のとき必須。それ以外の場合は無視される。very_lenient: 非常にゆるい / lenient: ゆるい / normal: 普通 / strict: 厳しい / very_strict: 非常に厳しい / strictest: 最も厳しい |
--strict-non-japanese-subject <value> | 任意 | 日本語を含まない件名に対して判定を厳しくする(true/false または 1/0)。standard のとき必須。それ以外の場合は無視される |
--strict-html-mail <value> | 任意 | HTMLメールに対して判定を厳しくする(true/false または 1/0)。standard のとき必須。それ以外の場合は無視される |
--white-list <addresses> | 任意 | ホワイトリスト(カンマ区切り。空文字でクリア) |
--black-list <addresses> | 任意 | ブラックリスト(カンマ区切り。空文字でクリア) |
使用例
xserver server spam-filter update example.com --detection-action trash
xserver server spam-filter update example.com --white-list ""
指定したドメインの受信側DMARC設定を更新します。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
--dmarc-receiver <value> | 必須 | 受信側DMARC設定(true/false または 1/0) |
使用例
xserver server spam-filter dmarc-receiver-update example.com --dmarc-receiver true
自動応答設定
設定済みの自動応答の一覧を返します。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server auto-reply list
指定したメールアドレスの自動応答設定(本文を含む)を返します。
引数
| 引数 | 説明 |
mailAddress | メールアドレス(user@domain 形式) |
使用例
xserver server auto-reply get info@example.com
未設定のメールアドレスに自動応答を新規追加します。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 必須 | ドメイン |
--mail-address <address> | 必須 | メールアドレス |
--from-name <name> | 必須 | 送信者名(空文字不可) |
--subject <subject> | 必須 | 件名(空文字不可) |
--body <body> | 必須 | 本文(空文字不可) |
--quote-incoming <value> | 必須 | 受信メールの引用を含めるか(true/false または 1/0) |
使用例
xserver server auto-reply add \
--domain example.com \
--mail-address info@example.com \
--from-name "Example Inc." \
--subject "お問い合わせありがとうございます" \
--body "担当者より折り返しご連絡いたします。" \
--quote-incoming true
既存の自動応答設定を更新します。更新用オプションを1つも指定しないとエラーになります。
引数
| 引数 | 説明 |
mailAddress | メールアドレス(user@domain 形式) |
オプション
| オプション | 必須 | 説明 |
--from-name <name> | 任意 | 送信者名(空文字不可)。指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます |
--subject <subject> | 任意 | 件名(空文字不可) |
--body <body> | 任意 | 本文(空文字不可) |
--quote-incoming <value> | 任意 | 受信メールの引用を含めるか(true/false または 1/0) |
使用例
xserver server auto-reply update info@example.com --subject "【自動応答】お問い合わせ受付"
指定したメールアドレスの自動応答設定を削除します。
引数
| 引数 | 説明 |
mailAddress | メールアドレス(user@domain 形式) |
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server auto-reply delete info@example.com
SMTP認証の国外アクセス制限
ドメインごとのSMTP認証の国外アクセス制限の有効/無効を返します。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server smtp-abroad-restriction list
xserver server smtp-abroad-restriction list --domain example.com
指定ドメインのSMTP認証の国外アクセス制限を有効または無効にします。
引数
オプション
| オプション | 必須 | 説明 |
--abroad-access-restriction <value> | 必須 | 国外アクセス制限の有効/無効(true/false または 1/0) |
使用例
xserver server smtp-abroad-restriction update example.com --abroad-access-restriction true
メール振り分け設定
条件とアクションで定義された振り分けルールの一覧を返します。--domain を指定すると、そのドメインのルールのみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server mail-filter list
新しいメール振り分けルールを追加します。複数条件が必要な場合はAPIを直接利用してください。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 必須 | ドメイン(最大253文字。日本語ドメインの場合はPunycodeで指定) |
--condition-keyword <keyword> | 必須 | マッチさせるキーワード |
--condition-field <field> | 必須 | 対象フィールド(subject: 件名 / from: 差出人 / to: あて先 / body: 本文 / header: ヘッダー全体) |
--condition-match-type <type> | 任意 | 一致条件(contain: キーワードを含む / match: キーワードと完全一致 / start_from: キーワードから始まる。デフォルト: contain) |
--action-type <type> | 必須 | 転送先種別(spam_folder: 迷惑メールフォルダに振り分け / trash: ゴミ箱に振り分け / delete: 削除する / mail_address: その他の宛先) |
--action-target <target> | 任意 | 転送先メールアドレスまたはコマンドパス(--action-type が mail_address の場合) |
--action-method <method> | 任意 | 処理方法(move: 転送(元のメールボックスには残さない) / copy: コピー転送(元のメールボックスにも残す)。デフォルト: move) |
使用例
xserver server mail-filter add \
--domain example.com \
--condition-keyword "spam@example.net" \
--condition-field from \
--condition-match-type match \
--action-type spam_folder
xserver server mail-filter add \
--domain example.com \
--condition-keyword "重要" \
--condition-field subject \
--action-type mail_address \
--action-target admin@example.com \
--action-method copy
指定したメール振り分けルールを削除します。
引数
| 引数 | 説明 |
filterId | 削除対象のフィルターID |
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server mail-filter delete 789
DKIM設定
ドメイン配下のサブドメインごとのDKIM有効/無効を返します。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
指定したFQDNのDKIM設定(DNSレコード情報を含む)を返します。
引数
| 引数 | 説明 |
fqdn | FQDN(example.com または sub.example.com) |
使用例
xserver server dkim get example.com
指定したFQDNのDKIMを有効または無効にします。
引数
| 引数 | 説明 |
fqdn | FQDN(example.com または sub.example.com) |
オプション
| オプション | 必須 | 説明 |
--enabled <value> | 必須 | DKIMの有効/無効(true/false または 1/0) |
使用例
xserver server dkim update example.com --enabled true
SPF設定
ドメイン配下のサブドメインごとのSPF設定を返します。初期ドメイン(契約のメインドメイン)およびそのホスト名への設定は含みません。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
指定したFQDNに標準SPFレコードを追加します。初期ドメイン(契約のメインドメイン)には設定できません。
オプション
| オプション | 必須 | 説明 |
--fqdn <fqdn> | 必須 | FQDN(example.com または sub.example.com) |
使用例
xserver server spf add --fqdn sub.example.com
指定したFQDNのSPF設定を更新します。enable_gmail 指定時にカスタム設定中はエラーになります。指定したFQDNのSPF設定が存在しない場合はエラーになります。SPFレコードが重複している場合はエラーになります。
引数
| 引数 | 説明 |
fqdn | FQDN(example.com または sub.example.com) |
オプション
| オプション | 必須 | 説明 |
--action <action> | 必須 | 操作種別。reset: 標準SPFへ初期化 / enable_gmail: 標準+Gmail許可のSPFを設定 / custom: カスタムSPFを設定 |
--spf-record <record> | 任意 | カスタムSPFレコード(--action custom のとき必須。v=spf1 で始まり、ダブルクォートを含まない) |
使用例
xserver server spf update sub.example.com --action reset
xserver server spf update sub.example.com --action enable_gmail
xserver server spf update sub.example.com --action custom --spf-record "v=spf1 +a:sv1234.xserver.jp +a:sub.example.com +mx include:spf.sender.xserver.jp ~all"
指定したFQDNのSPF設定を削除します。
引数
| 引数 | 説明 |
fqdn | FQDN(example.com または sub.example.com) |
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server spf delete sub.example.com
送信側DMARC設定
ドメインごとの送信側DMARC設定を返します。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server dmarc list
指定したドメインの送信側DMARC設定を更新します。更新用オプションを1つも指定しないとエラーになります。
引数
オプション
| オプション | 必須 | 説明 |
--policy <policy> | 任意 | DMARCポリシー(空文字不可)。none: 何もしない / quarantine: 迷惑メールとして配送する / reject: メールを配送しない。指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます |
--report-enabled <value> | 任意 | レポート通知の有効/無効(true/false または 1/0)。false のときレポート通知先メールアドレスは自動的に空になる |
--notification-mail-addresses <addresses> | 任意 | レポート通知先メールアドレス(カンマ区切り)。--report-enabled true と併用時は1件以上必須 |
使用例
xserver server dmarc update example.com --policy quarantine
xserver server dmarc update example.com --report-enabled false
FTPアカウント設定
登録済みFTPアカウントを一覧で返します。メインアカウントは含まれません。--domain を指定すると、そのドメインのアカウントのみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | ドメインで絞り込み |
使用例
xserver server ftp list --domain example.com
新しいFTPアカウントを追加します。
引数
| 引数 | 説明 |
ftpAccount | FTPアカウント(user@domain 形式) |
オプション
| オプション | 必須 | 説明 |
--password <password> | 必須 | パスワード |
--directory <dir> | 任意 | ディレクトリ |
--quota <mb> | 任意 | 容量制限(MB。0で無制限) |
--memo <value> | 任意 | メモ |
使用例
xserver server ftp add ftpuser@example.com \
--password "FtpPass123!"
xserver server ftp add ftpuser@example.com \
--password "FtpPass123!" \
--directory /public_html \
--quota 5000
指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります。
引数
| 引数 | 説明 |
ftpAccount | FTPアカウント(user@domain 形式) |
オプション
| オプション | 必須 | 説明 |
--password <password> | 任意 | パスワード |
--directory <dir> | 任意 | ディレクトリ |
--quota <mb> | 任意 | 容量制限(MB) |
--memo <value> | 任意 | メモ |
使用例
xserver server ftp update ftpuser@example.com --password "NewPass456!"
指定したFTPアカウントを削除します。
引数
| 引数 | 説明 |
ftpAccount | FTPアカウント(user@domain 形式) |
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server ftp delete ftpuser@example.com
MySQL設定
新しいデータベースを作成します。データベース名は「サーバーID_サフィックス」の形式になります。
引数
| 引数 | 説明 |
nameSuffix | データベース名のサフィックス(サーバーID_に続く部分) |
オプション
| オプション | 必須 | 説明 |
--character-set <charset> | 任意 | 文字コード(utf8mb4 / UTF-8 / EUC-JP / SHIFT-JIS / Binary。デフォルト: utf8mb4) |
--memo <value> | 任意 | メモ |
使用例
xserver server db add db01
xserver server db add db01 --character-set utf8mb4
指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります。
引数
オプション
| オプション | 必須 | 説明 |
--memo <value> | 任意 | メモ |
使用例
xserver server db update xs123456_db01 --memo "本番DB"
指定したデータベースを削除します。
引数
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server db delete xs123456_db01
MySQLユーザーの一覧を返します。
使用例
xserver server db user-list
新しいMySQLユーザーを作成します。ユーザー名は「サーバーID_サフィックス」の形式になります。
引数
| 引数 | 説明 |
nameSuffix | ユーザー名のサフィックス(サーバーID_に続く部分) |
オプション
| オプション | 必須 | 説明 |
--password <password> | 必須 | パスワード |
--memo <value> | 任意 | メモ |
使用例
xserver server db user-add user01 \
--password "DbPass123!"
指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります。
引数
オプション
| オプション | 必須 | 説明 |
--password <password> | 任意 | パスワード |
--memo <value> | 任意 | メモ |
使用例
xserver server db user-update xs123456_user01 --password "NewDbPass789!"
指定したMySQLユーザーを削除します。
引数
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server db user-delete xs123456_user01
指定したMySQLユーザーがアクセス権限を持つデータベースの一覧を返します。
引数
使用例
xserver server db grant-list xs123456_user01
指定したMySQLユーザーにデータベースへのアクセス権限を付与します。
引数
オプション
| オプション | 必須 | 説明 |
--db-name <dbName> | 必須 | 対象データベース名 |
使用例
xserver server db grant-add xs123456_user01 --db-name xs123456_db01
指定したMySQLユーザーからデータベースへのアクセス権限を削除します。
引数
オプション
| オプション | 必須 | 説明 |
--db-name <dbName> | 必須 | 対象データベース名 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server db grant-delete xs123456_user01 --db-name xs123456_db01
MySQLバックアップの取得・復元
各データベースで取得・復元申込に指定できるバックアップ日を返します。
使用例
xserver server mysql-backup databases
指定したバックアップ日のデータ取得(--operation-type fetch)または復元(--operation-type restore)を非同期で申し込みます。fetch 完了後は FTP 等で取得してください。restore は対象 DB を上書きする破壊的操作であり、取り消しできません。確認プロンプトが表示されます(-y でスキップ可能)。進捗は show をポーリングしてください。
オプション
| オプション | 必須 | 説明 |
--db-name <name> | 必須 | データベース名 |
--backup-date <date> | 必須 | 対象バックアップ日(Y-m-d) |
--operation-type <type> | 必須 | 処理種別。fetch: 自動バックアップデータの取得 / restore: 自動バックアップデータの復元 |
-y, --yes | 任意 | 確認プロンプトをスキップ(restore 時) |
使用例
xserver server mysql-backup create --db-name xs123456_db01 --backup-date 2026-06-01 --operation-type fetch
xserver server mysql-backup create --db-name xs123456_db01 --backup-date 2026-06-01 --operation-type restore
過去の取得・復元申込の履歴を返します。
使用例
xserver server mysql-backup list
指定した申込の詳細を返します。申込後の進捗確認に使用してください。
引数
| 引数 | 説明 |
requestId | 申込識別子(32文字の小文字16進数) |
使用例
xserver server mysql-backup show a3f29c1e8b0d4f2a9c1e5b7d3f8a2c1e
PHPバージョン設定
選択可能なPHPバージョン一覧と、ドメインごとの現在のバージョンを返します。--domain を指定すると、そのドメインの情報のみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | ドメインで絞り込み |
使用例
xserver server php-version get
xserver server php-version get --domain example.com
指定ドメインのPHPバージョンを変更します。
引数
オプション
| オプション | 必須 | 説明 |
--php <version> | 必須 | PHPバージョン(例: 8.2) |
使用例
xserver server php-version update example.com --php 8.2
php.ini設定
ドメインごとの php.ini 設定(settings)と、.user.ini による php.ini 相当設定の有効状態(user_ini_active)を返します。--domain を指定すると、そのドメインの情報のみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server php-ini list
xserver server php-ini list --domain example.com
指定ドメインの php.ini 設定を更新します。送信した項目のみ更新され、省略した項目は現在の設定が維持されます。更新用オプションを1つも指定しないとエラーになります。設定の反映には最大5分程度かかることがあります。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
--display-errors <value> | 任意 | PHPプログラム実行時のエラー内容を画面に出力するかどうかを設定します。On: ブラウザ上にエラーを表示 / Off: ブラウザ上にエラーを表示しない |
--error-reporting <value> | 任意 | PHPプログラム実行時のエラー出力レベルを設定します |
--display-startup-errors <value> | 任意 | PHP の起動シーケンスで発生するエラーを表示するかどうかを設定します。On: 表示する / Off: 表示しない |
--session-auto-start <value> | 任意 | リクエスト開始時にセッションを自動的に開始するかどうかを指定します。0: 自動開始しない / 1: 自動開始する |
--session-name <value> | 任意 | クッキーに設定されるセッション名を指定します |
--session-use-cookies <value> | 任意 | クライアント側へのセッションIDの保存に、クッキーを使用するかどうかを指定します。0: 使用しない / 1: 使用する |
--session-use-only-cookies <value> | 任意 | クライアント側へのセッションIDの保存に、クッキーのみを使用可能とする指定を行います。0: クッキーのみに限定しない / 1: クッキーのみを使用 |
--session-use-trans-sid <value> | 任意 | URLへのセッションIDの設定を自動で行うかを設定します。0: 自動設定しない / 1: 自動設定する |
--session-cookie-lifetime <value> | 任意 | クッキーの有効期間を(秒単位で)指定します。0を設定するとブラウザをクローズするまでセッションが有効となります |
--session-cookie-path <value> | 任意 | クッキーを有効とするパスを指定します。ここで指定したパス以下へのアクセスのみクッキーが有効となります |
--session-cookie-domain <value> | 任意 | クッキーを有効とするドメインを指定します |
--mbstring-language <value> | 任意 | デフォルトの言語を設定します |
--mbstring-internal-encoding <value> | 任意 | 内部文字エンコーディングを設定します |
--mbstring-http-input <value> | 任意 | HTTP入力文字エンコーディング変換を設定します |
--mbstring-http-output <value> | 任意 | HTTP出力文字エンコーディング変換を設定します |
--mbstring-encoding-translation <value> | 任意 | 内部文字エンコーディングへの変換を有効にするかどうかを設定します。On: 有効 / Off: 無効 |
--mbstring-detect-order <value> | 任意 | 文字コード検出を設定します |
--mbstring-substitute-character <value> | 任意 | 無効な文字を代替する文字を設定します |
--max-execution-time <value> | 任意 | 無限ループなどにより永続的に実行されているスクリプトが、強制終了されるまでの時間を秒単位で指定します |
--max-input-time <value> | 任意 | スクリプトが POST、GET、そしてファイルアップロードなどの入力をパースする最大の時間を秒単位で指定します |
--memory-limit <value> | 任意 | プログラムが使用できる最大メモリ数を指定します |
--post-max-size <value> | 任意 | POSTデータの許容最大サイズを設定します |
--upload-max-filesize <value> | 任意 | アップロードファイルの許容サイズを設定します |
--register-globals <value> | 任意 | 環境変数やGET値、POST値などの、PHPの外部からくる値を全て $変数名 という書式で使用可能とする設定を行います(PHP 5.3.0 で非推奨、Off推奨)。On: 有効 / Off: 無効 |
--magic-quotes-gpc <value> | 任意 | PHPのフォームより文字列データを取得する際、エスケープ処理(「'」や「"」や「\」の前に「\」を追加)を自動で行うかどうかを設定します。On: 有効 / Off: 無効 |
--safe-mode <value> | 任意 | プログラムファイルの所有者が、プログラム内の関数によって処理されているファイル及びディレクトリの所有者と同一かの確認を行う設定をします(※user_ini_active が true のときは変更できません)。On: 有効 / Off: 無効 |
--file-uploads <value> | 任意 | HTTP ファイルアップロードを可能とするかどうかを設定します(※user_ini_active が true のときは変更できません)。On: 有効 / Off: 無効 |
--allow-url-fopen <value> | 任意 | URLオブジェクトに対してファイル同様の操作を可能とする設定をします(※user_ini_active が true のときは変更できません) (PHP 5.2以降)。On: 有効 / Off: 無効 |
--allow-url-include <value> | 任意 | include関数、include_once関数、require関数、require_once関数で、URL対応のfopenラッパーが使用できるようになります(※user_ini_active が true のときは変更できません)。On: 有効 / Off: 無効 |
使用例
xserver server php-ini update example.com --memory-limit 1G
xserver server php-ini update example.com --display-errors Off
指定ドメインの php.ini をサーバー初期値で上書きします。取り消しできません。確認プロンプトが表示されます(-y でスキップ可能)。設定の反映には最大5分程度かかることがあります。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server php-ini reset example.com
xserver server php-ini reset example.com -y
ドメイン設定
サーバーに追加済みのドメインの一覧を返します。
使用例
xserver server domain list
ドキュメントルート、PHPバージョン、SSL設定状況を含む詳細情報を返します。
引数
使用例
xserver server domain get example.com
追加型ドメインをサーバーに追加します。追加時にドメイン所有権の確認(TXTレコード検証)が自動で実施されます。詳細は「ドメイン所有権確認」を参照してください。--ssl を true にすると無料SSLも設定されます。
引数
オプション
| オプション | 必須 | 説明 |
--ssl <value> | 任意 | SSL設定(デフォルト: true) |
--redirect-https <value> | 任意 | HTTPS転送設定(デフォルト: sslと同じ値) |
--ai-crawler-block <value> | 任意 | AIクローラー遮断設定(デフォルト: true) |
--memo <value> | 任意 | メモ |
使用例
xserver server domain add example.com
xserver server domain add example.com --ssl false
ドメインのメモを更新します。
引数
オプション
| オプション | 必須 | 説明 |
--memo <value> | 任意 | メモ |
使用例
xserver server domain update example.com --memo "メインサイト"
ドメインを削除します。--delete-files を指定すると、ユーザー公開領域のドメインディレクトリも合わせて削除します。
引数
オプション
| オプション | 必須 | 説明 |
--delete-files | 任意 | ユーザー公開領域のドメインディレクトリも削除する |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server domain delete example.com
xserver server domain delete example.com --delete-files
指定したドメインの設定を初期状態に戻します。
引数
オプション
| オプション | 必須 | 説明 |
--type <type> | 必須 | リセット種別(all: 全初期化 / web: Web領域のみ / other: Web以外) |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server domain reset example.com --type all
xserver server domain reset example.com --type web
サブドメイン設定
登録済みサブドメインの一覧を返します。--domain を指定すると、その親ドメインのサブドメインのみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | ドメインで絞り込み |
使用例
xserver server subdomain list
xserver server subdomain list --domain example.com
新しいサブドメインを追加します。--ssl を true にすると無料SSLも設定されます。短時間に連続して作成すると、一時的にエラーが返る場合があります。
引数
| 引数 | 説明 |
subdomain | サブドメイン名(例: blog.example.com) |
オプション
| オプション | 必須 | 説明 |
--document-root-type <type> | 任意 | ドキュメントルート種別(subdomain_only: /public_html/sub, full_subdomain: /public_html/sub.example.com) |
--ssl <value> | 任意 | SSL設定(デフォルト: true) |
--memo <value> | 任意 | メモ |
使用例
xserver server subdomain add blog.example.com
xserver server subdomain add blog.example.com --document-root-type full_subdomain
xserver server subdomain add blog.example.com --ssl false
指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります。
引数
オプション
| オプション | 必須 | 説明 |
--memo <value> | 任意 | メモ |
使用例
xserver server subdomain update blog.example.com --memo "ブログ用"
サブドメインを削除します。--delete-files を指定すると、ユーザー公開領域のサブドメインディレクトリも合わせて削除します。
引数
オプション
| オプション | 必須 | 説明 |
--delete-files | 任意 | 関連ファイルも削除する |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server subdomain delete blog.example.com
xserver server subdomain delete blog.example.com --delete-files
SSL設定
無料SSL(Let's Encrypt)およびオプションSSLの一覧を返します。--domain を指定すると、そのドメインの証明書のみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | ドメインで絞り込み |
使用例
指定ドメインに対して無料SSL証明書(Let's Encrypt)を発行・インストールします。対象ドメインのネームサーバーが当社ネームサーバーの場合のみ利用可能です。外部ネームサーバーを利用中の場合はサーバーパネルから操作してください。
引数
| 引数 | 説明 |
commonName | コモンネーム(ドメイン名) |
使用例
xserver server ssl install example.com
無料独自SSLをアンインストールします。
引数
| 引数 | 説明 |
commonName | コモンネーム(ドメイン名) |
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server ssl uninstall example.com
DNSレコード設定
ドメインに登録されたDNSレコードを一覧で返します。--domain を指定すると、そのドメインのレコードのみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | ドメインで絞り込み |
使用例
xserver server dns list --domain example.com
A, AAAA, CNAME, MX, TXT 等のレコードを追加します。MX の場合は --priority を指定できます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 必須 | 対象ドメイン |
--host <host> | 必須 | ホスト名(@でapex) |
--type <type> | 必須 | レコードタイプ(A / AAAA / CNAME / MX / TXT / SRV / NS) |
--content <content> | 必須 | レコード値 |
--ttl <ttl> | 任意 | TTL(60-86400。デフォルト: 3600) |
--priority <priority> | 任意 | 優先度(MX/SRVレコード用) |
使用例
xserver server dns add \
--domain example.com \
--host www \
--type A \
--content 203.0.113.1
xserver server dns add \
--domain example.com \
--host @ \
--type MX \
--content mail.example.com \
--priority 10
xserver server dns add \
--domain example.com \
--host @ \
--type TXT \
--content "v=spf1 include:example.com ~all"
指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。レコードを自動解決できない場合は --domain, --host, --type, --content の指定が必要です。
引数
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | ドメイン |
--host <host> | 任意 | ホスト名 |
--type <type> | 任意 | レコードタイプ |
--content <content> | 任意 | レコード値 |
--ttl <ttl> | 任意 | TTL(60-86400) |
--priority <priority> | 任意 | 優先度 |
使用例
xserver server dns update 456 --content 203.0.113.2
xserver server dns update 456 \
--domain example.com \
--host www \
--type A \
--content 203.0.113.2
指定したDNSレコードを削除します。
引数
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server dns delete 456
アクセスログ
指定ドメインのアクセスログを取得します。--lines で末尾からの取得行数、--keyword で絞り込みが可能です。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 必須 | 対象ドメイン |
--lines <n> | 任意 | 取得行数(末尾から) |
--keyword <keyword> | 任意 | キーワード検索 |
使用例
xserver server log access --domain example.com --lines 100
xserver server log access \
--domain example.com \
--keyword "POST" \
--lines 50
エラーログ
指定ドメインのエラーログを取得します。--lines で末尾からの取得行数、--keyword で絞り込みが可能です。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 必須 | 対象ドメイン |
--lines <n> | 任意 | 取得行数(末尾から) |
--keyword <keyword> | 任意 | キーワード検索 |
使用例
xserver server log error --domain example.com --lines 50
xserver server log error --domain example.com
Xアクセラレータ設定
契約ドメインごとの Xアクセラレータ設定を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server x-accelerator list
xserver server x-accelerator list --domain example.com
指定ドメインの Xアクセラレータ設定を変更します。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
--xaccelerator-status <status> | 必須 | Xアクセラレータ設定(off: OFF / v1: Xアクセラレータ Ver.1 / v2: Xアクセラレータ Ver.2) |
使用例
xserver server x-accelerator update example.com --xaccelerator-status v1
xserver server x-accelerator update example.com --xaccelerator-status off
サーバーキャッシュ設定
契約ドメインごとのサーバーキャッシュ設定を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server server-cache list
xserver server server-cache list --domain example.com
指定ドメインのサーバーキャッシュ設定を変更します。ECサイトやログインが必要なサイトでは、キャッシュによる意図しない公開にご注意ください。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
--server-cache-status <status> | 必須 | サーバーキャッシュ設定(on: ON / off: OFF) |
使用例
xserver server server-cache update example.com --server-cache-status on
xserver server server-cache update example.com --server-cache-status off
指定ドメインのキャッシュ内容を削除します。設定(ON/OFF)は変更しません。確認プロンプトが表示されます(-y でスキップ可能)。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver server server-cache clear-cache example.com
xserver server server-cache clear-cache example.com -y
ブラウザキャッシュ設定
契約ドメインごとのブラウザキャッシュ設定と反映状態(is_applied)を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server browser-cache list
xserver server browser-cache list --domain example.com
指定ドメインのブラウザキャッシュ設定を変更します。反映には最大15分程度かかることがあります。反映状態は list の is_applied で確認できます。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
--browser-cache-status <status> | 必須 | ブラウザキャッシュ設定(all: ON(全ての静的ファイル) / ignore-css-js: ON(CSS/JavaScript以外) / off: OFF) |
使用例
xserver server browser-cache update example.com --browser-cache-status all
xserver server browser-cache update example.com --browser-cache-status off
WAF設定
契約ドメインごとの WAF 設定を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。
オプション
| オプション | 必須 | 説明 |
--domain <domain> | 任意 | 絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません) |
使用例
xserver server waf list --domain example.com
指定ドメインの WAF 設定を更新します。指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。更新用オプションを1つも指定しないとエラーになります。設定の反映には最大1時間程度かかることがあります。
引数
| 引数 | 説明 |
domain | 対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定) |
オプション
| オプション | 必須 | 説明 |
--xss-protection <value> | 任意 | XSS対策(true/false または 1/0) |
--sql-injection-protection <value> | 任意 | SQL対策(true/false または 1/0) |
--file-protection <value> | 任意 | ファイル対策(true/false または 1/0) |
--mail-protection <value> | 任意 | メール対策(true/false または 1/0) |
--command-protection <value> | 任意 | コマンド対策(true/false または 1/0) |
--php-protection <value> | 任意 | PHP対策(true/false または 1/0) |
使用例
xserver server waf update example.com --xss-protection true
© 2026 XServer Inc.