XServer APIコマンド一覧｜公式CLIで使えるサーバー管理コマンドを整理

XServer APIコマンド一覧｜公式CLIで使えるサーバー管理コマンドを整理

XServer APIコマンド一覧｜公式CLIで使えるサーバー管理コマンドを整理

ご訪問ありがとうございます。今回は「XServer APIコマンド一覧」についてご紹介します。XServer APIをターミナルから扱える公式CLIを中心に、認証、サーバー情報、WordPress、MySQL、ドメイン、SSL、DNS、ログなどのコマンドを整理します。

XServer APIコマンド一覧の前提

XServer CLIは、XServer APIをコマンドラインから操作する公式ツールです。
インストール後は、xserver コマンドでサーバー情報取得や設定変更を実行できます。
APIキーが必要なため、認証情報は安全に管理します。

XServer APIをターミナルから扱う場合、公式のXServer CLIを使うと、HTTPリクエストを直接組み立てずにサーバー管理コマンドを実行できます。公式リファレンスでは、xserver server 配下にサーバー管理コマンドが整理されています。

XServer APIそのものについては、前回の記事 XServer APIとは｜できること・使い方・WordPress運用での活用方法でも整理しています。この記事では、実際に使うコマンドの分類に絞ってご紹介します。

項目	内容	確認ポイント
公式CLI	XServer CLI	`xserver` コマンドで操作
対象	エックスサーバー / XServerビジネス	契約サービスと初期ドメインを確認
認証	APIキー	権限、有効期限、IP制限を確認
出力	table / json	人間確認ならtable、自動化ならjson

インストールと認証コマンド

Node.js 18以上の環境で、npmからインストールできます。
APIキーは xserver auth login で設定できます。
CI/CDやスクリプトでは環境変数での指定も使えます。

XServer CLIはnpmからインストールできます。すぐ試したい場合は、npx xserver-cli server info のようにインストールせず実行する方法も公式リファレンスで案内されています。

目的	コマンド	用途
インストール	`npm install -g xserver-cli`	CLIをグローバルに導入
即時実行	`npx xserver-cli server info`	インストールせずに試す
バージョン確認	`xserver --version`	CLIのバージョン確認
ログイン	`xserver auth login`	対話形式でAPIキーを設定
認証状態	`xserver auth status`	現在の認証状態を確認
プロファイル一覧	`xserver auth profiles`	保存済みプロファイルを確認
APIキー情報	`xserver me`	認証中のAPIキー情報を確認

共通オプション

出力形式は --format table または --format json で指定できます。
複数環境を使う場合は --profile が便利です。
削除や初期化で --yes を使う場合は、対象を必ず確認します。

XServer CLIには、すべてのコマンドで使える共通オプションがあります。人間が読む場合はテーブル形式、自動化やCodexでの解析にはJSON形式が扱いやすくなります。

オプション	意味	使いどころ
`--format table`	テーブル形式で出力	目視確認
`--format json`	JSON形式で出力	スクリプト連携、Codexでの解析
`--profile <name>`	プロファイル指定	本番・検証環境の切り替え
`--servername <name>`	サーバー名の一時指定	対象サーバーを明示したい場合
`-y, --yes`	確認プロンプトをスキップ	削除・初期化では慎重に使う
`-h, --help`	ヘルプ表示	コマンドの使い方確認

サーバー情報・利用状況コマンド

最初に試すなら、読み取り系のサーバー情報コマンドが安全です。
サーバースペックや利用状況を確認できます。
Codexに調査させる場合も、まず読み取り系から始めると安心です。

サーバー管理の入口になるのが、サーバー情報と利用状況の取得です。設定変更を伴わないため、XServer CLIの動作確認にも向いています。

目的	コマンド	内容
サーバー情報	`xserver server info`	サーバーの基本情報を取得
利用状況	`xserver server usage`	ディスク使用量や設定件数を取得
JSON出力	`xserver --format json server info`	JSON形式で情報取得

WordPress・MySQL関連コマンド

WordPress運用では、WordPress関連とMySQL関連のコマンドが重要です。
作成・削除系の操作は、バックアップと対象確認を行ってから実行します。
Codexには、まず一覧取得や設定確認を任せるのが安全です。

WordPressサイト運用では、WordPress設定、データベース、MySQLユーザーの管理が関係します。XServer CLIのリファレンスでは、MySQL設定としてデータベース一覧、作成、削除、MySQLユーザー管理、権限操作などが案内されています。

分類	主なコマンド系統	用途
WordPress	`xserver server wordpress ...`	WordPress関連設定の確認・操作
データベース一覧	`xserver server mysql database list`	MySQLデータベース一覧を取得
データベース作成	`xserver server mysql database create`	新規DBを作成
データベース削除	`xserver server mysql database delete`	DBを削除
MySQLユーザー	`xserver server mysql user ...`	ユーザー一覧・作成・変更・削除
DB権限	`xserver server mysql privilege ...`	権限取得・付与・削除

コマンド名やサブコマンドはCLIの更新で変わる可能性があります。実行前に xserver server --help や公式リファレンスで確認してください。

ドメイン・SSL・DNS関連コマンド

ドメイン、SSL、DNSはサイト表示に直結する重要な設定です。
追加や削除の前に、対象ドメインと反映影響を確認します。
DNS変更は反映待ちがあるため、すぐに結果が見えない場合があります。

ドメイン、サブドメイン、SSL、DNSレコードは、WordPressサイトの表示やメール到達にも影響する設定です。読み取り系の一覧取得は便利ですが、追加・削除・更新系は慎重に扱います。

分類	主なコマンド系統	用途
ドメイン設定	`xserver server domain ...`	ドメイン一覧・詳細・追加・削除
サブドメイン	`xserver server subdomain ...`	サブドメイン一覧・追加・削除
SSL設定	`xserver server ssl ...`	SSL一覧、無料SSLのインストール・アンインストール
DNSレコード	`xserver server dns ...`	DNSレコード一覧・追加・更新・削除
PHPバージョン	`xserver server php ...`	PHPバージョン取得・変更

メール・FTP・ログ関連コマンド

メール関連はアカウント、転送、迷惑メール、DKIM、SPFなど多くの設定があります。
FTPアカウントはファイル操作につながるため、権限管理が重要です。
ログ取得は、エラー調査やアクセス状況確認に役立ちます。

XServer CLIでは、メール関連設定、FTPアカウント、アクセスログ、エラーログなども扱えます。メールやFTPはサイト運用の基盤なので、誤削除や誤設定を避けるため、読み取り系から始めるのがおすすめです。

分類	主なコマンド系統	用途
メールアカウント	`xserver server mail ...`	メールアカウント一覧・追加・変更・削除
迷惑メール設定	`xserver server spam-filter ...`	迷惑メールフィルタ取得・更新
メール振り分け	`xserver server mail-filter ...`	振り分け設定の一覧・追加・削除
DKIM / SPF / DMARC	`xserver server dkim ...` など	送信ドメイン認証関連の確認・更新
FTPアカウント	`xserver server ftp ...`	FTPアカウント一覧・追加・変更・削除
ログ	`xserver server log ...`	アクセスログ・エラーログ取得

Codexで使うときの安全な順番

まず読み取り系コマンドで対象サーバーと状態を確認します。
次にJSON出力でCodexに要約・比較させます。
作成・削除・更新系は、バックアップと確認を挟んでから実行します。

CodexとXServer CLIを組み合わせる場合、いきなり変更系コマンドを実行するのではなく、まず読み取り系コマンドで状況を確認します。たとえば、サーバー情報、利用状況、ドメイン一覧、MySQL一覧、ログ取得などです。

JSON出力にすると、Codexが結果を要約したり、差分を見たり、チェックリストへ変換しやすくなります。削除や初期化を伴うコマンドで --yes を使う場合は、対象を必ず確認してから実行します。

段階	コマンド例	Codexに任せること
確認	`xserver server info`	対象サーバーの要約
一覧取得	`xserver --format json server usage`	利用状況の整理
調査	`xserver server log ...`	エラー原因の候補整理
変更前	`xserver server ... list`	変更対象の確認表作成
変更	`xserver server ... create/update/delete`	承認後の実行補助

公式情報・参考ページ

コマンド名やサブコマンドは、公式リファレンスで確認します。
APIキー、権限、レート制限、初期ドメインの指定も公式ページで確認します。

まとめ

XServer APIコマンドは、公式XServer CLIの xserver コマンドで扱えます。
サーバー情報、WordPress、MySQL、ドメイン、SSL、DNS、メール、FTP、ログなどを分類して確認すると理解しやすくなります。
Codexと組み合わせる場合は、読み取り系から始め、変更系は確認とバックアップを挟むのが安全です。

XServer APIコマンドは、サーバーパネルで行う作業をターミナルやスクリプトから扱いやすくするための入口です。まずは xserver auth login、xserver server info、xserver server usage のような安全な確認系から始め、WordPressやMySQL、DNSなどの変更系コマンドは、対象確認とバックアップをそろえてから進めると安心です。

コマンド一覧は、覚えるためではなく、作業前に危険な操作を見分ける地図として使うと役立ちます。