マニュアル MANUAL
XServer CLI
-
XServer CLIとは
サーバー管理やドメイン管理などの各サービスの機能を、コマンドラインから操作できる公式ツールです。
XServerドメインでは、契約ドメインの情報取得、ネームサーバー設定、Whois設定、ドメイン取得・移管などのドメイン管理機能をターミナルから直接実行できます。
CI/CDパイプラインへの組み込みや、スクリプトによる一括操作にもご活用いただけます。ご利用の前に
「属性型JP・プレミアムドメインの取得・移管」「JPドメインの移管」はAPIではご利用になれません。
-
ご利用方法
ご利用にはNode.js(v18以上)およびXServer APIキーが必要です。
APIキーの発行方法は、マニュアル「XServer API」をご参照ください。インストール方法、認証設定、各コマンドの使い方などCLIの詳しいご利用方法は、CLIリファレンスをご参照ください。
-
CLIの仕様
各コマンドの詳細な仕様については、CLIリファレンスをご参照ください。
-
注意事項
ご注意ください
- ・ご利用にはNode.js(v18以上)のインストールが必要です。Node.jsはhttps://nodejs.org/からダウンロードできます。
- ・APIキーは安全な場所に保管してください。第三者にAPIキーが漏洩した場合、サーバーやドメインの不正操作が行われる恐れがあります。
- ・万が一、APIキーが漏洩した場合は、速やかにAPIキーを削除してください。APIキーの削除方法は「APIキーの削除手順」をご参照ください。
- ・CLIを通じた操作にもXServer APIのレート制限が適用されます。レート制限の詳細は、マニュアル「XServer API」をご参照ください。