CLI Reference

XServer CLI リファレンス — サーバー管理

XServer CLI は、XServer API をコマンドラインから操作するための公式 CLI ツールです。サーバーの設定変更・情報取得をターミナルから直接実行でき、運用の自動化やスクリプト連携を可能にします。

このリファレンスでは xserver server 配下のサーバー管理コマンドを網羅しています。

CLIの変更履歴は 更新履歴 を参照してください。

インストール

Node.js(v18 以上)がインストールされた環境で、npm からグローバルインストールしてください。

インストール
npm install -g xserver-cli

インストール後は、ターミナルのどのディレクトリからでも xserver コマンドが利用可能です。

インストールせずに即時実行することもできます。

npx で即時実行
npx xserver-cli server info

バージョン確認

バージョン確認
xserver --version

認証設定

APIを利用するには、事前にAPIキーを設定する必要があります。APIキーはXServerアカウント画面の「APIキー管理」から発行できます。

APIキーの発行手順については、下記マニュアルをご参照ください。

xserver auth login

対話形式でAPIキーを設定します。APIキーの入力はセキュリティのためマスク表示(***)され、ログイン時に GET /v1/meservices.server からサーバー名(初期ドメイン)を解決します。

APIキーのサーバー対象設定に応じて、サーバー名の扱いは次のとおりです。

APIキーのサーバー対象挙動
1台(target_mode: selectedtargets が1件)サーバー名を自動検出してプロファイルに保存
複数台(targets が2件以上)対話形式では選択プロンプトを表示。非対話(CI/CD 等)では --servername の指定が必要
「すべてのサーバー」(target_mode: all警告を表示。servername 未固定のままプロファイルを保存
サーバー区分なし警告を表示。servername 未固定のままプロファイルを保存
対象サーバーが1台のキー(自動検出)
xserver auth login
# ✔ APIキーを入力: ****
# 認証情報を検証中...
# ✓ 認証に成功しました
#   サーバー名を自動検出しました: xs123456.xsrv.jp
# ✓ プロファイル "default" を保存しました
「すべてのサーバー」等(servername 未固定)
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 auth profiles
プロファイル一覧をJSON形式で確認
xserver --format json auth profiles

設定ファイルは ~/.config/xserver-cli/config.json に保存されます。

環境変数

環境変数でもAPIキーとサーバー名を指定できます。CI/CD パイプラインでの利用に適しています。

環境変数説明
XSERVER_API_KEYAPIキー
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 auth status
認証状態をJSON形式で確認
xserver --format json auth status

グローバルオプション

すべてのコマンドで共通して利用できるオプションです。

オプション説明デフォルト
--format <format>出力形式(table または jsontable
--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が設定されている場合のみ使用されます。

出力形式

テーブル形式(デフォルト)

人間が読みやすい形式で出力します。

テーブル形式
xserver server cron list

JSON形式

プログラムからの利用やパイプラインでの処理に適した形式です。jq コマンドと組み合わせて使うこともできます。

JSON形式
xserver --format json server cron list
jq と組み合わせ
xserver --format json server cron list | jq ".crons[].command"

レート制限エラー

APIの利用上限を超えた場合、CLIは RATE_LIMIT_EXCEEDED エラーを表示して終了します。HTTPレスポンスに Retry-After ヘッダーが含まれる場合は、その秒数を目安に待ってから再実行してください。

通常の分あたり・日あたり・同時リクエスト数の上限に加えて、認証失敗が短時間に続いた場合はIPアドレス単位で一時的にブロックされます。APIキーや環境変数の設定を確認してから再試行してください。

APIキー情報

認証中のAPIキー情報を取得 xserver me

現在認証に使用しているAPIキーの情報を返します。有効期限・紐づくサーバー名・権限種別を確認できます。

使用例

基本的な使い方
xserver me
JSON形式で出力
xserver --format json me

サーバー情報

サーバー情報を取得 xserver server info

サーバーのスペック・ソフトウェアバージョン・ネームサーバーなどの基本情報を返します。サーバーパネルの「サーバー情報」画面に相当します。

使用例

基本的な使い方
xserver server info
JSON形式で出力
xserver --format json server info
サーバー利用状況を取得 xserver server usage

ディスク使用量・ファイル数・各種設定件数を返します。サーバーパネルのトップページに表示される利用状況に相当します。ディスク容量はサーバーパネルと同じ基準(MB を 1000 で除算した小数2桁)で GB 換算した値を返します。

使用例

基本的な使い方
xserver server usage

自動バックアップの取得・復元

選択可能なバックアップ日一覧を取得 xserver server auto-backup backup-dates

取得・復元の申込(create)で指定できる backup_date の候補を返します。通常14日分ですが、サーバーによっては7日分のみの場合があります。

使用例

基本的な使い方
xserver server auto-backup backup-dates
自動バックアップの取得または復元を申し込む xserver server auto-backup create [options]

指定したバックアップ日のデータ取得(--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 list
自動バックアップ申込履歴の詳細を取得 xserver server auto-backup show <requestId>

指定した申込の詳細を返します。申込後の進捗確認に使用してください。

引数

引数説明
requestId申込ID(正の整数)

使用例

基本的な使い方
xserver server auto-backup show 12345

Cron設定

Cron一覧を取得 xserver server cron list

登録済みのCron設定を一覧で返します。各要素の id は PUT/DELETE で指定するハッシュIDです。

使用例

基本的な使い方
xserver server cron list
Cronを新規追加 xserver server cron add [options]

新しいCron設定を追加します。レスポンスの id は後続の PUT・DELETE で使用します。

オプション

オプション必須説明
--minute <value>必須分(例: */5, 0, *)
--hour <value>必須時(例: *, 3, 0-6)
--command <value>必須実行コマンド
--day <value>任意日(デフォルト: *)
--month <value>任意月(デフォルト: *)
--weekday <value>任意曜日(デフォルト: *)
--comment <value>任意コメント

使用例

毎日0時に実行
xserver server cron add \
  --minute 0 --hour 0 \
  --command "/usr/bin/php /home/user/batch.php"
5分おきに実行
xserver server cron add \
  --minute "*/5" --hour "*" \
  --command "/home/user/check.sh" \
  --comment "定期チェック"
Cronを変更 xserver server cron update <cronId> [options]

既存のCron設定を変更します。指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります。スケジュール・コマンド・コメントなどの内容を変更すると id が変わります。後続の update / delete ではレスポンスの新しい id を使用してください。

引数

引数説明
cronId更新対象のCron ID

オプション

オプション必須説明
--minute <value>任意
--hour <value>任意
--day <value>任意
--month <value>任意
--weekday <value>任意曜日
--command <value>任意実行コマンド
--comment <value>任意コメント
--enabled <value>任意有効/無効(true / false)

使用例

Cronを無効化
xserver server cron update 123 --enabled false
実行時間を変更
xserver server cron update 123 --minute 30 --hour 3
Cronを削除 xserver server cron delete <cronId> [options]

指定したCronジョブを削除します。

引数

引数説明
cronId削除対象のCron ID

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server cron delete 123

SSH設定

SSH設定を取得 xserver server ssh show

SSH接続の有効/無効、国外アクセス制限の状態、接続情報、登録済み公開鍵数を返します。

使用例

基本的な使い方
xserver server ssh show
SSH設定を変更 xserver server ssh update [options]

SSH接続の有効/無効、国外アクセス制限の有効/無効を変更します。変更したいフィールドのみ送信してください。SSH公開鍵の登録・更新・削除の結果によっては、SSH接続および国外アクセス制限が自動で有効/無効される場合があります。

オプション

オプション必須説明
--ssh-enabled <value>任意SSH接続の有効/無効(true/false)
--abroad-access-restriction <value>任意国外アクセス制限の有効/無効(true/false)

使用例

SSHを有効化
xserver server ssh update --ssh-enabled true
国外アクセス制限を無効化
xserver server ssh update --abroad-access-restriction false
SSH公開鍵一覧を取得 xserver server ssh key list

登録済みSSH公開鍵の一覧を返します。

使用例

基本的な使い方
xserver server ssh key list
SSH公開鍵を登録 xserver server ssh key add [options]

公開鍵を手動で登録するか、--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"
SSH公開鍵を更新 xserver server ssh key update <keyId> [options]

ラベルやステータス(on/off)を変更します。変更したいフィールドのみ送信してください。ステータスの変更により、公開鍵が有効になる一つ目の場合は SSH接続および国外アクセス制限が自動で有効になります。有効な公開鍵が0件になる場合は SSH接続および国外アクセス制限が自動で無効になります。

引数

引数説明
keyId公開鍵ID

オプション

オプション必須説明
--label <value>任意ラベル
--status <value>任意ステータス(on/off)

使用例

ラベルを更新
xserver server ssh key update 1 --label "新しいラベル"
公開鍵を無効化
xserver server ssh key update 1 --status off
SSH公開鍵を削除 xserver server ssh key delete <keyId> [options]

指定したSSH公開鍵を削除します。公開鍵がすべて削除されて有効な公開鍵が0件になる場合は、SSH接続および国外アクセス制限が自動で無効になります。

引数

引数説明
keyId公開鍵ID

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server ssh key delete 1

リソースモニター

指定日のCPU・メモリ・転送量時系列を取得 xserver server resource-monitor get [options]

指定日の CPU・メモリ・転送量を5分刻みの時系列で返します。--date は当日を含む直近1か月以内のみ指定できます。出力データ量が多いため、--format json の使用を推奨します。※ 本機能は XServerビジネス(全プラン)では利用できません。

オプション

オプション必須説明
--date <date>必須対象日(Y-m-d または Ymd。当日含む直近1か月)

使用例

基本的な使い方
xserver server resource-monitor get --date 20260609 --format json

サイト転送設定

サイト転送設定一覧を取得 xserver server url-redirect list [options]

サイト転送設定の一覧を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

基本的な使い方
xserver server url-redirect list
特定ドメインの設定を取得
xserver server url-redirect list --domain example.com
サイト転送設定を追加 xserver server url-redirect add [options]

サイト転送設定を追加します。

オプション

オプション必須説明
--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
サイト転送設定を削除 xserver server url-redirect delete <redirectId> [options]

指定したサイト転送設定を削除します。確認プロンプトが表示されます(-y でスキップ可能)。

引数

引数説明
redirectIdサイト転送設定のID

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server url-redirect delete a1b2c3d4e5f67890
確認をスキップ
xserver server url-redirect delete a1b2c3d4e5f67890 -y

アクセス拒否設定

アクセス拒否設定一覧を取得 xserver server access-deny list [options]

アクセス拒否設定の一覧を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。サーバーキャッシュが有効なドメインでは、拒否設定が反映されない場合があります。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

基本的な使い方
xserver server access-deny list
特定ドメインの設定を取得
xserver server access-deny list --domain example.com
アクセス拒否設定を追加 xserver server access-deny add [options]

指定ドメインにアクセス拒否設定を追加します。

オプション

オプション必須説明
--domain <domain>必須契約ドメイン(最大253文字。日本語ドメインの場合はPunycodeで指定)
--ip-address <address>必須拒否IPアドレス・ホスト(IPv4 / CIDR / 部分IP / ホスト名)
--memo <memo>任意メモ(最大500文字)

使用例

IPアドレスを拒否
xserver server access-deny add --domain example.com --ip-address 192.168.1.1 --memo 社内テスト用
CIDR を拒否
xserver server access-deny add --domain example.com --ip-address 203.0.113.0/24
アクセス拒否設定のメモを更新 xserver server access-deny update <denyId> [options]

指定したアクセス拒否設定のメモのみを更新します。

引数

引数説明
denyIdアクセス拒否設定のID(list または add で得られる id)

オプション

オプション必須説明
--memo <memo>必須メモ(最大500文字。空文字でクリア)

使用例

メモを更新
xserver server access-deny update a1b2c3d4e5f67890 --memo 更新メモ
メモをクリア
xserver server access-deny update a1b2c3d4e5f67890 --memo ""
アクセス拒否設定を削除 xserver server access-deny delete <denyId> [options]

指定したアクセス拒否設定を削除します。確認プロンプトが表示されます(-y でスキップ可能)。

引数

引数説明
denyIdアクセス拒否設定のID

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server access-deny delete a1b2c3d4e5f67890
確認をスキップ
xserver server access-deny delete a1b2c3d4e5f67890 -y

XPageSpeed設定

XPageSpeed設定一覧を取得 xserver server xpagespeed list [options]

契約ドメインごとの XPageSpeed 設定を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。※ 本機能は XServerビジネス(全プラン)、エックスサーバー(旧X2スタンダードプラン / 旧X2アドバンスドプラン)では利用できません。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

全ドメインの設定を取得
xserver server xpagespeed list
特定ドメインの設定を取得
xserver server xpagespeed list --domain example.com
XPageSpeedの最適化機能を変更 xserver server xpagespeed update <domain> [options]

指定ドメインの 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一覧を取得 xserver server wp list [options]

簡単インストールでインストール済みのWordPress一覧を返します。--domain を指定すると、そのドメインのインストールのみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意ドメインで絞り込み

使用例

全件取得
xserver server wp list
ドメインで絞り込み
xserver server wp list --domain example.com
WordPressを新規インストール xserver server wp add [options]

指定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設定を変更 xserver server wp update <wpId> [options]

WordPressの設定を変更します。現在変更可能な項目はメモのみです。

引数

引数説明
wpId更新対象のWordPress ID

オプション

オプション必須説明
--memo <value>任意メモ

使用例

基本的な使い方
xserver server wp update 456 --memo "本番サイト"
WordPressを削除 xserver server wp delete <wpId> [options]

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
DBユーザーも一緒に削除
xserver server wp delete 456 --delete-db-user true

WordPressセキュリティ設定

WordPressセキュリティ設定一覧を取得 xserver server wordpress-security get [options]

契約ドメインごとの WordPress セキュリティ設定(コメント制限・ログイン試行回数制限・国外アクセス制限・IPアドレス制限)を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

全ドメインの設定を取得
xserver server wordpress-security get
特定ドメインの設定を取得
xserver server wordpress-security get --domain example.com
WordPressセキュリティ設定を更新 xserver server wordpress-security update <domain> [options]

指定ドメインの 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
ホワイトリストに複数IPを指定
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 ""

メールアカウント設定

メールアカウント一覧を取得 xserver server mail list [options]

サーバーに登録済みのメールアカウントを一覧で返します。--domain を指定すると、そのドメインのアカウントのみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

全件取得
xserver server mail list
ドメインで絞り込み
xserver server mail list --domain example.com
メールアカウント詳細を取得 xserver server mail get <mailAccount>

指定したメールアカウントの詳細情報(容量・使用量を含む)を返します。

引数

引数説明
mailAccountメールアカウント(例: user@example.com)。URLエンコードすること

使用例

基本的な使い方
xserver server mail get info@example.com
メールアカウントを作成 xserver server mail add <mailAddress> [options]

メールアカウントを作成します。作成時にドメイン所有権の確認(TXTレコード検証)が自動で実施されます。詳細は「ドメイン所有権確認」を参照してください。

引数

引数説明
mailAddressメールアドレス

オプション

オプション必須説明
--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
メールアカウントを変更 xserver server mail update <mailAccount> [options]

指定したメールアカウントを変更します。

引数

引数説明
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!"
メールアカウントを削除 xserver server mail delete <mailAccount> [options]

指定したメールアカウントを削除します。

引数

引数説明
mailAccountメールアカウント(例: user@example.com)。URLエンコードすること

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server mail delete info@example.com
メール転送設定を取得 xserver server mail forwarding-get <mailAccount>

指定したメールアカウントの転送設定を返します。

引数

引数説明
mailAccountメールアカウント(例: user@example.com)。URLエンコードすること

使用例

基本的な使い方
xserver server mail forwarding-get info@example.com
メール転送設定を更新 xserver server mail forwarding-update <mailAccount> [options]

指定したメールアカウントのメール転送設定を更新します。更新用オプションを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

迷惑メールフィルタ

迷惑メールフィルタ設定を取得 xserver server spam-filter list [options]

指定したドメインの迷惑メールフィルタ設定を返します。--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
迷惑メールフィルタ設定を更新 xserver server spam-filter update <domain> [options]

指定したドメインの迷惑メールフィルタ設定を更新します。迷惑メールフィルタを標準スパムフィルタ(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設定を更新 xserver server spam-filter dmarc-receiver-update <domain> [options]

指定したドメインの受信側DMARC設定を更新します。

引数

引数説明
domain対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定)

オプション

オプション必須説明
--dmarc-receiver <value>必須受信側DMARC設定(true/false または 1/0)

使用例

受信側DMARCを有効化
xserver server spam-filter dmarc-receiver-update example.com --dmarc-receiver true

自動応答設定

自動応答設定一覧を取得 xserver server auto-reply list [options]

設定済みの自動応答の一覧を返します。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

基本的な使い方
xserver server auto-reply list
自動応答設定の詳細を取得 xserver server auto-reply get <mailAddress>

指定したメールアドレスの自動応答設定(本文を含む)を返します。

引数

引数説明
mailAddressメールアドレス(user@domain 形式)

使用例

基本的な使い方
xserver server auto-reply get info@example.com
自動応答設定を追加 xserver server auto-reply add [options]

未設定のメールアドレスに自動応答を新規追加します。

オプション

オプション必須説明
--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
自動応答設定を更新 xserver server auto-reply update <mailAddress> [options]

既存の自動応答設定を更新します。更新用オプションを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 "【自動応答】お問い合わせ受付"
自動応答設定を削除 xserver server auto-reply delete <mailAddress> [options]

指定したメールアドレスの自動応答設定を削除します。

引数

引数説明
mailAddressメールアドレス(user@domain 形式)

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server auto-reply delete info@example.com

SMTP認証の国外アクセス制限

SMTP認証の国外アクセス制限設定を取得 xserver server smtp-abroad-restriction list [options]

ドメインごとのSMTP認証の国外アクセス制限の有効/無効を返します。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

基本的な使い方
xserver server smtp-abroad-restriction list
ドメインで絞り込み
xserver server smtp-abroad-restriction list --domain example.com
SMTP認証の国外アクセス制限設定を更新 xserver server smtp-abroad-restriction update <domain> [options]

指定ドメインのSMTP認証の国外アクセス制限を有効または無効にします。

引数

引数説明
domainドメイン

オプション

オプション必須説明
--abroad-access-restriction <value>必須国外アクセス制限の有効/無効(true/false または 1/0)

使用例

国外アクセス制限を有効化
xserver server smtp-abroad-restriction update example.com --abroad-access-restriction true

メール振り分け設定

メール振り分け設定一覧を取得 xserver server mail-filter list [options]

条件とアクションで定義された振り分けルールの一覧を返します。--domain を指定すると、そのドメインのルールのみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

基本的な使い方
xserver server mail-filter list
メール振り分け設定を追加 xserver server mail-filter add [options]

新しいメール振り分けルールを追加します。複数条件が必要な場合は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
メール振り分け設定を削除 xserver server mail-filter delete <filterId> [options]

指定したメール振り分けルールを削除します。

引数

引数説明
filterId削除対象のフィルターID

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server mail-filter delete 789

DKIM設定

DKIM設定一覧を取得 xserver server dkim list [options]

ドメイン配下のサブドメインごとのDKIM有効/無効を返します。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

基本的な使い方
xserver server dkim list
DKIM設定の詳細を取得 xserver server dkim get <fqdn>

指定したFQDNのDKIM設定(DNSレコード情報を含む)を返します。

引数

引数説明
fqdnFQDN(example.com または sub.example.com)

使用例

基本的な使い方
xserver server dkim get example.com
DKIM設定を更新 xserver server dkim update <fqdn> [options]

指定したFQDNのDKIMを有効または無効にします。

引数

引数説明
fqdnFQDN(example.com または sub.example.com)

オプション

オプション必須説明
--enabled <value>必須DKIMの有効/無効(true/false または 1/0)

使用例

DKIMを有効化
xserver server dkim update example.com --enabled true

SPF設定

SPF設定一覧を取得 xserver server spf list [options]

ドメイン配下のサブドメインごとのSPF設定を返します。初期ドメイン(契約のメインドメイン)およびそのホスト名への設定は含みません。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

基本的な使い方
xserver server spf list
SPF設定を追加 xserver server spf add [options]

指定したFQDNに標準SPFレコードを追加します。初期ドメイン(契約のメインドメイン)には設定できません。

オプション

オプション必須説明
--fqdn <fqdn>必須FQDN(example.com または sub.example.com)

使用例

基本的な使い方
xserver server spf add --fqdn sub.example.com
SPF設定を更新 xserver server spf update <fqdn> [options]

指定したFQDNのSPF設定を更新します。enable_gmail 指定時にカスタム設定中はエラーになります。指定したFQDNのSPF設定が存在しない場合はエラーになります。SPFレコードが重複している場合はエラーになります。

引数

引数説明
fqdnFQDN(example.com または sub.example.com)

オプション

オプション必須説明
--action <action>必須操作種別。reset: 標準SPFへ初期化 / enable_gmail: 標準+Gmail許可のSPFを設定 / custom: カスタムSPFを設定
--spf-record <record>任意カスタムSPFレコード(--action custom のとき必須。v=spf1 で始まり、ダブルクォートを含まない)

使用例

標準SPFへ初期化
xserver server spf update sub.example.com --action reset
Gmail許可を有効化
xserver server spf update sub.example.com --action enable_gmail
カスタムSPFレコードを指定
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"
SPF設定を削除 xserver server spf delete <fqdn> [options]

指定したFQDNのSPF設定を削除します。

引数

引数説明
fqdnFQDN(example.com または sub.example.com)

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server spf delete sub.example.com

送信側DMARC設定

送信側DMARC設定を取得 xserver server dmarc list [options]

ドメインごとの送信側DMARC設定を返します。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

基本的な使い方
xserver server dmarc list
送信側DMARC設定を更新 xserver server dmarc update <domain> [options]

指定したドメインの送信側DMARC設定を更新します。更新用オプションを1つも指定しないとエラーになります。

引数

引数説明
domainドメイン

オプション

オプション必須説明
--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アカウント一覧を取得 xserver server ftp list [options]

登録済みFTPアカウントを一覧で返します。メインアカウントは含まれません。--domain を指定すると、そのドメインのアカウントのみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意ドメインで絞り込み

使用例

基本的な使い方
xserver server ftp list
ドメインで絞り込み
xserver server ftp list --domain example.com
FTPアカウントを追加 xserver server ftp add <ftpAccount> [options]

新しいFTPアカウントを追加します。

引数

引数説明
ftpAccountFTPアカウント(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
FTPアカウントを変更 xserver server ftp update <ftpAccount> [options]

指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります。

引数

引数説明
ftpAccountFTPアカウント(user@domain 形式)

オプション

オプション必須説明
--password <password>任意パスワード
--directory <dir>任意ディレクトリ
--quota <mb>任意容量制限(MB)
--memo <value>任意メモ

使用例

パスワードを変更
xserver server ftp update ftpuser@example.com --password "NewPass456!"
FTPアカウントを削除 xserver server ftp delete <ftpAccount> [options]

指定したFTPアカウントを削除します。

引数

引数説明
ftpAccountFTPアカウント(user@domain 形式)

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server ftp delete ftpuser@example.com

MySQL設定

データベース一覧を取得 xserver server db list

MySQLデータベースの一覧を返します。

使用例

基本的な使い方
xserver server db list
データベースを作成 xserver server db add <nameSuffix> [options]

新しいデータベースを作成します。データベース名は「サーバー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
データベースのメモを更新 xserver server db update <dbName> [options]

指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります。

引数

引数説明
dbNameデータベース名

オプション

オプション必須説明
--memo <value>任意メモ

使用例

基本的な使い方
xserver server db update xs123456_db01 --memo "本番DB"
データベースを削除 xserver server db delete <dbName> [options]

指定したデータベースを削除します。

引数

引数説明
dbNameデータベース名

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server db delete xs123456_db01
MySQLユーザー一覧を取得 xserver server db user-list

MySQLユーザーの一覧を返します。

使用例

基本的な使い方
xserver server db user-list
MySQLユーザーを作成 xserver server db user-add <nameSuffix> [options]

新しいMySQLユーザーを作成します。ユーザー名は「サーバーID_サフィックス」の形式になります。

引数

引数説明
nameSuffixユーザー名のサフィックス(サーバーID_に続く部分)

オプション

オプション必須説明
--password <password>必須パスワード
--memo <value>任意メモ

使用例

基本的な使い方
xserver server db user-add user01 \
  --password "DbPass123!"
MySQLユーザーを変更 xserver server db user-update <dbUser> [options]

指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります。

引数

引数説明
dbUserMySQLユーザー名

オプション

オプション必須説明
--password <password>任意パスワード
--memo <value>任意メモ

使用例

パスワードを変更
xserver server db user-update xs123456_user01 --password "NewDbPass789!"
MySQLユーザーを削除 xserver server db user-delete <dbUser> [options]

指定したMySQLユーザーを削除します。

引数

引数説明
dbUserMySQLユーザー名

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server db user-delete xs123456_user01
データベース権限を取得 xserver server db grant-list <dbUser>

指定したMySQLユーザーがアクセス権限を持つデータベースの一覧を返します。

引数

引数説明
dbUserMySQLユーザー名

使用例

基本的な使い方
xserver server db grant-list xs123456_user01
データベース権限を付与 xserver server db grant-add <dbUser> [options]

指定したMySQLユーザーにデータベースへのアクセス権限を付与します。

引数

引数説明
dbUserMySQLユーザー名

オプション

オプション必須説明
--db-name <dbName>必須対象データベース名

使用例

基本的な使い方
xserver server db grant-add xs123456_user01 --db-name xs123456_db01
データベース権限を削除 xserver server db grant-delete <dbUser> [options]

指定したMySQLユーザーからデータベースへのアクセス権限を削除します。

引数

引数説明
dbUserMySQLユーザー名

オプション

オプション必須説明
--db-name <dbName>必須対象データベース名
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server db grant-delete xs123456_user01 --db-name xs123456_db01

MySQLバックアップの取得・復元

MySQLバックアップの状態を取得 xserver server mysql-backup databases

各データベースで取得・復元申込に指定できるバックアップ日を返します。

使用例

基本的な使い方
xserver server mysql-backup databases
MySQLバックアップの取得または復元を申し込む xserver server mysql-backup create [options]

指定したバックアップ日のデータ取得(--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
MySQLバックアップ申込履歴一覧を取得 xserver server mysql-backup list

過去の取得・復元申込の履歴を返します。

使用例

基本的な使い方
xserver server mysql-backup list
MySQLバックアップ申込履歴詳細を取得 xserver server mysql-backup show <requestId>

指定した申込の詳細を返します。申込後の進捗確認に使用してください。

引数

引数説明
requestId申込識別子(32文字の小文字16進数)

使用例

基本的な使い方
xserver server mysql-backup show a3f29c1e8b0d4f2a9c1e5b7d3f8a2c1e

PHPバージョン設定

PHPバージョン設定を取得 xserver server php-version get [options]

選択可能なPHPバージョン一覧と、ドメインごとの現在のバージョンを返します。--domain を指定すると、そのドメインの情報のみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意ドメインで絞り込み

使用例

全ドメインのPHPバージョンを確認
xserver server php-version get
特定ドメインのPHPバージョンを確認
xserver server php-version get --domain example.com
PHPバージョンを変更 xserver server php-version update <domain> [options]

指定ドメインのPHPバージョンを変更します。

引数

引数説明
domain対象ドメイン

オプション

オプション必須説明
--php <version>必須PHPバージョン(例: 8.2)

使用例

基本的な使い方
xserver server php-version update example.com --php 8.2

php.ini設定

php.ini設定を取得 xserver server php-ini list [options]

ドメインごとの 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設定を更新 xserver server php-ini update <domain> [options]

指定ドメインの 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: 無効

使用例

memory_limit のみ変更
xserver server php-ini update example.com --memory-limit 1G
display_errors を Off に変更
xserver server php-ini update example.com --display-errors Off
php.ini設定を初期値に戻す xserver server php-ini reset <domain> [options]

指定ドメインの 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

サーバーに追加済みのドメインの一覧を返します。

使用例

基本的な使い方
xserver server domain list
ドメイン詳細を取得 xserver server domain get <domain>

ドキュメントルート、PHPバージョン、SSL設定状況を含む詳細情報を返します。

引数

引数説明
domainドメイン名

使用例

基本的な使い方
xserver server domain get example.com
ドメインを追加 xserver server domain add <domain> [options]

追加型ドメインをサーバーに追加します。追加時にドメイン所有権の確認(TXTレコード検証)が自動で実施されます。詳細は「ドメイン所有権確認」を参照してください。--ssl を true にすると無料SSLも設定されます。

引数

引数説明
domainドメイン名

オプション

オプション必須説明
--ssl <value>任意SSL設定(デフォルト: true)
--redirect-https <value>任意HTTPS転送設定(デフォルト: sslと同じ値)
--ai-crawler-block <value>任意AIクローラー遮断設定(デフォルト: true)
--memo <value>任意メモ

使用例

基本的な使い方
xserver server domain add example.com
SSL無効で追加
xserver server domain add example.com --ssl false
ドメインのメモを更新 xserver server domain update <domain> [options]

ドメインのメモを更新します。

引数

引数説明
domainドメイン名

オプション

オプション必須説明
--memo <value>任意メモ

使用例

基本的な使い方
xserver server domain update example.com --memo "メインサイト"
ドメインを削除 xserver server domain delete <domain> [options]

ドメインを削除します。--delete-files を指定すると、ユーザー公開領域のドメインディレクトリも合わせて削除します。

引数

引数説明
domainドメイン名

オプション

オプション必須説明
--delete-files任意ユーザー公開領域のドメインディレクトリも削除する
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server domain delete example.com
ファイルも削除
xserver server domain delete example.com --delete-files
ドメイン設定を初期化 xserver server domain reset <domain> [options]

指定したドメインの設定を初期状態に戻します。

引数

引数説明
domainドメイン名

オプション

オプション必須説明
--type <type>必須リセット種別(all: 全初期化 / web: Web領域のみ / other: Web以外)
-y, --yes任意確認プロンプトをスキップ

使用例

全設定を初期化
xserver server domain reset example.com --type all
Web領域のみ初期化
xserver server domain reset example.com --type web

サブドメイン設定

サブドメイン一覧を取得 xserver server subdomain list [options]

登録済みサブドメインの一覧を返します。--domain を指定すると、その親ドメインのサブドメインのみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意ドメインで絞り込み

使用例

基本的な使い方
xserver server subdomain list
ドメインで絞り込み
xserver server subdomain list --domain example.com
サブドメインを追加 xserver server subdomain add <subdomain> [options]

新しいサブドメインを追加します。--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
SSL無効で追加
xserver server subdomain add blog.example.com --ssl false
サブドメインのメモを更新 xserver server subdomain update <subdomain> [options]

指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。更新用オプションを1つも指定しないとエラーになります。

引数

引数説明
subdomainサブドメイン名

オプション

オプション必須説明
--memo <value>任意メモ

使用例

基本的な使い方
xserver server subdomain update blog.example.com --memo "ブログ用"
サブドメインを削除 xserver server subdomain delete <subdomain> [options]

サブドメインを削除します。--delete-files を指定すると、ユーザー公開領域のサブドメインディレクトリも合わせて削除します。

引数

引数説明
subdomainサブドメイン名

オプション

オプション必須説明
--delete-files任意関連ファイルも削除する
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server subdomain delete blog.example.com
ファイルも削除
xserver server subdomain delete blog.example.com --delete-files

SSL設定

SSL設定一覧を取得 xserver server ssl list [options]

無料SSL(Let's Encrypt)およびオプションSSLの一覧を返します。--domain を指定すると、そのドメインの証明書のみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意ドメインで絞り込み

使用例

基本的な使い方
xserver server ssl list
無料SSLをインストール xserver server ssl install <commonName>

指定ドメインに対して無料SSL証明書(Let's Encrypt)を発行・インストールします。対象ドメインのネームサーバーが当社ネームサーバーの場合のみ利用可能です。外部ネームサーバーを利用中の場合はサーバーパネルから操作してください。

引数

引数説明
commonNameコモンネーム(ドメイン名)

使用例

基本的な使い方
xserver server ssl install example.com
無料SSLをアンインストール xserver server ssl uninstall <commonName> [options]

無料独自SSLをアンインストールします。

引数

引数説明
commonNameコモンネーム(ドメイン名)

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server ssl uninstall example.com

DNSレコード設定

DNSレコード一覧を取得 xserver server dns list [options]

ドメインに登録されたDNSレコードを一覧で返します。--domain を指定すると、そのドメインのレコードのみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意ドメインで絞り込み

使用例

基本的な使い方
xserver server dns list
ドメインで絞り込み
xserver server dns list --domain example.com
DNSレコードを追加 xserver server dns add [options]

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レコード用)

使用例

Aレコードを追加
xserver server dns add \
  --domain example.com \
  --host www \
  --type A \
  --content 203.0.113.1
MXレコードを追加
xserver server dns add \
  --domain example.com \
  --host @ \
  --type MX \
  --content mail.example.com \
  --priority 10
TXTレコードを追加
xserver server dns add \
  --domain example.com \
  --host @ \
  --type TXT \
  --content "v=spf1 include:example.com ~all"
DNSレコードを更新 xserver server dns update <dnsId> [options]

指定したオプションのみ更新され、省略したオプションは現在の設定が維持されます。空文字を指定した場合は空で上書きされます。レコードを自動解決できない場合は --domain, --host, --type, --content の指定が必要です。

引数

引数説明
dnsIdDNSレコードID

オプション

オプション必須説明
--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レコードを削除 xserver server dns delete <dnsId> [options]

指定したDNSレコードを削除します。

引数

引数説明
dnsIdDNSレコードID

オプション

オプション必須説明
-y, --yes任意確認プロンプトをスキップ

使用例

基本的な使い方
xserver server dns delete 456

アクセスログ

アクセスログを取得 xserver server log access [options]

指定ドメインのアクセスログを取得します。--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

エラーログ

エラーログを取得 xserver server log error [options]

指定ドメインのエラーログを取得します。--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アクセラレータ設定一覧を取得 xserver server x-accelerator list [options]

契約ドメインごとの Xアクセラレータ設定を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

全ドメインの設定を取得
xserver server x-accelerator list
特定ドメインの設定を取得
xserver server x-accelerator list --domain example.com
Xアクセラレータ設定を変更 xserver server x-accelerator update <domain> [options]

指定ドメインの Xアクセラレータ設定を変更します。

引数

引数説明
domain対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定)

オプション

オプション必須説明
--xaccelerator-status <status>必須Xアクセラレータ設定(off: OFF / v1: Xアクセラレータ Ver.1 / v2: Xアクセラレータ Ver.2)

使用例

Xアクセラレータ Ver.1 を有効化
xserver server x-accelerator update example.com --xaccelerator-status v1
Xアクセラレータを OFF にする
xserver server x-accelerator update example.com --xaccelerator-status off

サーバーキャッシュ設定

サーバーキャッシュ設定一覧を取得 xserver server server-cache list [options]

契約ドメインごとのサーバーキャッシュ設定を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

全ドメインの設定を取得
xserver server server-cache list
特定ドメインの設定を取得
xserver server server-cache list --domain example.com
サーバーキャッシュ設定を変更 xserver server server-cache update <domain> [options]

指定ドメインのサーバーキャッシュ設定を変更します。ECサイトやログインが必要なサイトでは、キャッシュによる意図しない公開にご注意ください。

引数

引数説明
domain対象ドメイン(例: example.com。日本語ドメインの場合はPunycodeで指定)

オプション

オプション必須説明
--server-cache-status <status>必須サーバーキャッシュ設定(on: ON / off: OFF)

使用例

サーバーキャッシュを ON にする
xserver server server-cache update example.com --server-cache-status on
サーバーキャッシュを OFF にする
xserver server server-cache update example.com --server-cache-status off
サーバーキャッシュの内容を削除 xserver server server-cache clear-cache <domain> [options]

指定ドメインのキャッシュ内容を削除します。設定(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

ブラウザキャッシュ設定

ブラウザキャッシュ設定一覧を取得 xserver server browser-cache list [options]

契約ドメインごとのブラウザキャッシュ設定と反映状態(is_applied)を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

全ドメインの設定を取得
xserver server browser-cache list
特定ドメインの設定を取得
xserver server browser-cache list --domain example.com
ブラウザキャッシュ設定を変更 xserver server browser-cache update <domain> [options]

指定ドメインのブラウザキャッシュ設定を変更します。反映には最大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
ブラウザキャッシュを OFF にする
xserver server browser-cache update example.com --browser-cache-status off

WAF設定

WAF設定一覧を取得 xserver server waf list [options]

契約ドメインごとの WAF 設定を返します。--domain を指定すると、そのドメインの設定のみに絞り込めます。

オプション

オプション必須説明
--domain <domain>任意絞り込み対象のドメイン(省略時は全ドメイン。日本語ドメインの場合はPunycodeで指定。サブドメインでの絞り込みには対応していません)

使用例

全ドメインの設定を取得
xserver server waf list
特定ドメインの設定を取得
xserver server waf list --domain example.com
WAF設定を更新 xserver server waf update <domain> [options]

指定ドメインの 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)

使用例

XSS対策のみ有効化
xserver server waf update example.com --xss-protection true