VPS API、クラウドサーバーを JSON REST で自動化

はい、VPS API は全会員が無料で利用できます。API キーの発行とリクエストは無料で、API で作成したサーバーとオプションは、コントロールパネルで作成したサーバーと同じ料金で支払われます。最初の支払いを行った会員は、API キーページですぐにキーを作成できます。

最初の支払いを行うと、API キーページ (/api-key) が開き、そこでキーを作成します。Bearer スキームを使用してすべてのリクエストの Authorization ヘッダーにキーを入れます。キーはアカウント全体を扱うので、コードリポジトリにコミットせず、環境変数やシークレットストアに保管してください。

販売一覧の取得(GET /catalog)、サーバー一覧と1台の情報の取得(GET /servers、GET /servers/{id})、サーバーの作成(POST /servers)、起動、停止、再起動(start、stop、reboot)、1か月の更新(renew)、削除(DELETE /servers/{id})ができます。リクエスト例とレスポンス形式は API ドキュメントにあります。

キー1つで1分あたり300回までリクエストできます。上限を超えると 429 ステータスコードと rate_limited エラーが返るので、スクリプトで少し待ってから再送するように処理してください。サーバー一覧の確認や電源管理のような日常的な自動化は、この上限内で十分に動作します。リクエスト数に応じた料金はありません。

POST /servers リクエストが成功すると、選択した請求期間分の支払いが処理され、サーバーが作成されます。作成に失敗したサーバーの支払いはアカウントクレジットに戻ります。

サーバー作成リクエストのレスポンスに root_password の値が1回だけ含まれます。レスポンスを受け取ったらすぐに安全な場所に保存してください。コントロールパネルでも7日間再表示でき、SSH キー番号も一緒に送っておけば、パスワードなしでキーを使ってすぐに接続できます。レスポンスの ipv4 の値ですぐに SSH 接続を始められるので、デプロイスクリプトとの連携にも便利です。

はい、サーバー作成リクエストの ssh_key_id に登録済みの SSH キー番号を入れると、新しいサーバーにそのキーが設定されます。キーの登録はコントロールパネルの SSH キー画面で一度行えばよく、フィンガープリントは ssh-keygen と同じ形式で表示されるので、どのキーかすぐに確認できます。キー番号は一度決めたら繰り返し使えます。

HTTP リクエストを送れるなら、どの言語やツールでも使えます。curl ですぐに試し、Python の requests、Node.js の fetch、GitLab CI のスクリプトステップ、Terraform の HTTP リクエスト機能から、同じ URL とヘッダーで呼び出せます。レスポンスはすべて JSON なので、結果を読み取りやすくなっています。

エラーは、2xx 以外のステータスコードとともに error の値を含む JSON で返ります。キーが間違っていれば unauthorized、値が欠けていれば bad_request、残高が足りなければ not_enough_balance、サーバーの状態と合わないリクエストなら wrong_state のように理由が分かれているので、プログラムで状況ごとに処理できます。

はい、API とコントロールパネルは同じアカウントと同じサーバーを扱います。API で作成したサーバーはコントロールパネルの一覧にそのまま表示され、コントロールパネルで OS を再インストールしたりパスワードを確認したりできます。1アカウントあたりサーバー10台の上限も、両方の方式に共通で適用されます。手作業とコードによる操作を組み合わせても、状態と支払日は常に同じように表示されます。