カスタマーAPI · V1 ベータ
VPS・専用サーバー向け
REST API
サーバーをコードで管理：時間課金VPSの注文と削除、電源操作や再インストールの実行、独自イメージのキャプチャとデプロイ、残高からの請求書の支払いが可能です。
X-ZoneServersカスタマーAPI（v1、パブリックベータ）は、HTTPS経由で92のAPI操作を提供します。OpenAPI 3.0仕様、スコープ付きAPIキー、キーごとに1時間あたり1,000リクエストのデフォルト上限を備え、すべてのアカウントに追加料金なしで含まれています。
92 API操作1,000 リクエスト/時（キーごと）
最初のAPI呼び出し
クライアントエリアの「Profile → API Keys」でキーを作成し、APIに「自分は誰か」を問い合わせてみましょう。
curl https://my.x-zoneservers.com/api/v1/ \
-H "Authorization: Bearer $XZ_API_KEY"
{ "success": true,
"data": {
"version": "1",
"key": { "scopes": ["read", "services"] },
"rate_limit": { "limit": 1000, "remaining": 999 }
} }01機能
自動化できること
APIは注文から請求書まで、サーバーのライフサイクル全体をカバーし、クライアントエリアと同じ権限で動作します。
デプロイと削除
時間課金または月額課金でVPSを注文し、初回起動用にcloud-initのuser-dataとSSHキーを渡して、作業が終わったら削除できます。時間課金はサーバーが削除された瞬間に停止します。
電源・再インストール・統計
VPSの起動、停止、再起動、再インストール、rootパスワードのリセットに加え、監視スクリプトから使用量やトラフィックの統計を取得できます。
カスタムイメージ
VPSをイメージとしてキャプチャする（1アカウントにつき最大3個）か、独自のqcow2またはrawイメージ（SHA-256で検証）を登録して、そこから新しいサーバーをデプロイできます。
請求と使用量
アカウント残高と今月の時間課金額の取得、請求書とプロフォーマ請求書の一覧表示、残高からの支払いが可能です。コストダッシュボードや予算アラートに役立ちます。
アドオンとアップグレード
追加IPアドレスなど既存サービスのアドオンを購入したり、クライアントエリアを開かずに上位プランへ移行したりできます。
プロジェクトとスコープ付きキー
サーバーをプロジェクトにまとめ、1つのプロジェクトだけに紐づくキーを発行できます。ステージング用のキーが本番環境を参照したり操作したりすることはありません。
02仕組み
例：CIジョブ1回分の時間課金VPS
クリーンなビルドマシンを作成し、パイプラインを実行して削除 — 支払いは存在した時間分だけです。
時間課金のサービスは請求書ではなくアカウント残高から差し引かれるため、アカウントに残高を確保しておいてください。注文のたびにIdempotency-Keyヘッダーを送信すれば、タイムアウトしたリクエストを再試行しても2台目のサーバーは作成されません。
1. プランを選ぶ：製品を時間料金・月額料金とともに一覧表示します。
curl https://my.x-zoneservers.com/api/v1/products \
-H "Authorization: Bearer $XZ_API_KEY"2. 初回起動スクリプトとSSHキーを指定し、時間課金で注文します。
curl -X POST https://my.x-zoneservers.com/api/v1/orders \
-H "Authorization: Bearer $XZ_API_KEY" \
-H "Idempotency-Key: ci-run-4812" \
-H "Content-Type: application/json" \
-d '{"productId": "<plan-id>", "billingCycle": "hourly",
"hostname": "ci-4812.example.com", "location": "<location>",
"configOptions": {"os_image_id": "<image-id>",
"ssh_keys": ["ssh-ed25519 AAAA... ci@runner"],
"user_data": "#!/bin/sh\n/opt/ci/run-pipeline.sh"}}'3. ジョブが終わったらサーバーを削除します。課金は即座に停止します。
curl -X DELETE https://my.x-zoneservers.com/api/v1/vps/<vps-id> \
-H "Authorization: Bearer $XZ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"immediate": true}'03API
スクリプトとAIエージェントのために設計
ボタンを押すのが人ではなくプログラムなら、エンドポイントの数よりも予測どおりに動くことのほうが重要です。
スコープ付きキー
各キーには付与したスコープ（read、services、orders、billing、destructive）だけが含まれ、任意でIP許可リストと有効期限も設定できます。
公開されたレート制限
デフォルトはキーごとに1時間あたり1,000リクエストで、X-RateLimitヘッダーで通知されます。電源操作と再インストールには、サーバーごとに短いクールダウンがあります。
安全なリトライ
注文はIdempotency-Keyに対応し、拒否された場合は必ず機械可読なエラーコードが返されるため、自動化処理は再試行できる失敗と本当の失敗を区別できます。
機械可読なドキュメント
クライアント生成ツール向けのOpenAPI 3.0仕様と、コーディングアシスタントやAIエージェントがそのまま読めるプレーンなMarkdownガイドを用意しています。
04関連
ご自身の顧客にサーバーを販売していますか？
このカスタマーAPIは、ご自身のアカウントを自動化するためのものです。自社ブランドで再販する場合は、リセラープログラムに参加し、代わりにリセラーAPIをご利用ください。数量に応じた段階制の卸売価格、HMAC署名付きリクエスト、Webhook、顧客に紐づくキー、そしてお客様の顧客が当社のアカウントなしで開けるコンソールリンクを利用できます。
05よくある質問
API よくあるご質問
X-ZoneServersの自動化に関するよくある質問。
X-ZoneServersにAPIはありますか？
はい。カスタマーAPI（v1）は https://my.x-zoneservers.com/api/v1 で提供されるHTTPS経由のREST APIで、VPS、専用サーバー、注文、アドオン、アップグレード、請求書、SSHキー、カスタムイメージをカバーする92の操作を備えています。現在はパブリックベータ版です。開発の基盤にできるほど安定していますが、エンドポイントやレスポンスの形式は今後も変更される可能性があります。
APIは無料で利用できますか？
はい。APIアクセスはすべてのアカウントに追加料金なしで含まれています。お支払いいただくのは注文したサーバーとアドオンの料金のみで、価格はWebサイトやクライアントエリアと同じです。
APIで時間課金VPSを作成・削除できますか？
はい。請求サイクルを時間単位に設定して注文し（cloud-initのuser-dataとSSHキーも任意で指定可能）、不要になったらVPSを削除します。時間課金のサービスはアカウント残高から差し引かれ、削除した時点で課金が止まります。
APIは専用サーバーにも対応していますか？
一部対応しています。専用サーバーについては、注文、アドオン、請求書、サービスの詳細をAPIで扱えます。電源制御、OSの再インストール、パスワードのリセットは、専用サーバーではAPIからもクライアントエリアからも利用できません。
認証はどのように行いますか？
クライアントエリアの「Profile → API Keys」でAPIキーを作成し、Bearerトークンとして送信します。スコープは作成時に選択し、必要に応じて特定のIPアドレスに制限したり、有効期限を設定したりできます。キーは一度しか表示されず、クライアントエリアからいつでも失効させられます。
OpenAPIまたはSwaggerの仕様はありますか？
はい。完全なOpenAPI 3.0仕様を https://my.x-zoneservers.com/api/v1/openapi.json で公開しており、レンダリング済みのドキュメントとMarkdown形式の利用ガイドも併せて用意しています。
はじめる
最初のAPIキーを作成
クライアントエリアにサインインして「Profile → API Keys」を開けば、1分以内に最初のAPI呼び出しができます。APIに関するご質問は、プラットフォームを開発するスタッフに直接届きます。