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キーの入力はセキュリティのためマスク表示（***）され、サーバー名（初期ドメイン）はAPIキーの検証結果から自動検出されます。

対話形式でログイン

xserver auth login
# ✔ APIキーを入力: ****
# 認証情報を検証中...
# ✓ 認証に成功しました
#   サーバー名を自動検出しました: xs123456.xsrv.jp
# ✓ プロファイル "default" を保存しました

オプションで非対話的に設定することも可能です（CI/CD 環境向け）。通常はサーバー名を指定する必要はありません。

非対話形式

xserver auth login --api-key YOUR_API_KEY

自動検出されたサーバー名を一時的に上書きしたい場合のみ、--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_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

現在の認証状態を確認します。

認証状態の確認

xserver auth status

認証状態をJSON形式で確認

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が設定されている場合のみ使用されます。

出力形式

テーブル形式（デフォルト）

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

テーブル形式

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

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

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

メールアカウント設定

メールアカウント一覧を取得 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 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

自動応答設定

自動応答設定一覧を取得 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

DKIM設定

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

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

オプション

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

使用例

基本的な使い方

xserver server dkim list

DKIM設定の詳細を取得 xserver server dkim get <fqdn>

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

引数

引数	説明
`fqdn`	FQDN（example.com または sub.example.com）

使用例

基本的な使い方

xserver server dkim get example.com

DKIM設定を更新 xserver server dkim update <fqdn> [options]

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

引数

引数	説明
`fqdn`	FQDN（example.com または sub.example.com）

オプション

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

使用例

DKIMを有効化

xserver server dkim update example.com --enabled true

送信側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

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レコードが重複している場合はエラーになります。

引数

引数	説明
`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 で始まり、ダブルクォートを含まない）

使用例

標準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設定を削除します。

引数

引数	説明
`fqdn`	FQDN（example.com または sub.example.com）

オプション

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

使用例

基本的な使い方

xserver server spf delete sub.example.com

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アカウントを追加します。

引数

引数	説明
`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

FTPアカウントを変更 xserver server ftp update <ftpAccount> [options]

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

引数

引数	説明
`ftpAccount`	FTPアカウント（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アカウントを削除します。

引数

引数	説明
`ftpAccount`	FTPアカウント（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]

引数

引数	説明
`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]

引数

引数	説明
`dbUser`	MySQLユーザー名

オプション

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

使用例

パスワードを変更

xserver server db user-update xs123456_user01 --password "NewDbPass789!"

MySQLユーザーを削除 xserver server db user-delete <dbUser> [options]

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

引数

引数	説明
`dbUser`	MySQLユーザー名

オプション

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

使用例

基本的な使い方

xserver server db user-delete xs123456_user01

データベース権限を取得 xserver server db grant-list <dbUser>

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

引数

引数	説明
`dbUser`	MySQLユーザー名

使用例

基本的な使い方

xserver server db grant-list xs123456_user01

データベース権限を付与 xserver server db grant-add <dbUser> [options]

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

引数

引数	説明
`dbUser`	MySQLユーザー名

オプション

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

使用例

基本的な使い方

xserver server db grant-add xs123456_user01 --db-name xs123456_db01

データベース権限を削除 xserver server db grant-delete <dbUser> [options]

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

引数

引数	説明
`dbUser`	MySQLユーザー名

オプション

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

使用例

基本的な使い方

xserver server db grant-delete xs123456_user01 --db-name xs123456_db01

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

ドメイン設定

ドメイン一覧を取得 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]

引数

引数	説明
`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 の指定が必要です。

引数

引数	説明
`dnsId`	DNSレコード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レコードを削除します。

引数

引数	説明
`dnsId`	DNSレコード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>`	任意	キーワード検索