VPS API ドキュメント、サーバー作成と管理の REST API

HTTPS で JSON をやり取りする REST API です。Authorization ヘッダーに API キーを1つ送るだけで、スペックの取得からサーバー作成、電源管理、更新、削除まで、アカウント画面で行う操作をそのままプログラムで実行できます。アカウントごとに1分あたり 300 回までリクエストできます。

API でできること

API は、たくさんのサーバーを扱いたいときや、デプロイを自動化したいときに使う方法です。プラン、リージョン、イメージの一覧を取得し、サーバーを作成すると支払いが処理され、確認後にサーバーが作成されます。ウェブページと同じルールが適用されるため、API で作成したサーバーもアカウントのサーバー一覧に表示されます。

はじめての方は、API クイックスタートガイドでキーの作成から最初のサーバー作成まで、順番に進めてみてください。このページは、すべてのエンドポイントとフィールドを1か所にまとめたリファレンスです。

ベース URL

すべてのリクエストは、以下の URL の後ろにパスを付けて送ります。リクエストとレスポンスの本文はすべて JSON(UTF-8)です。

https://helpervps.com/api/v1

認証

Authorization: Bearer YOUR_API_KEY ヘッダーを送ってください。キーは最初の支払いが確認された後にアカウントの API キーメニューで作成でき、hvp_ で始まります。キーの全体が表示されるのは作成直後の1回だけで、新しいキーを作成すると既存のキーはすぐに使えなくなります。

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

リクエスト制限

すべてのリクエスト	アカウントごとに1分あたり 300 回
サーバー作成 (POST /servers)	アカウントごとに10分あたり10回
アカウントのサーバー数	10 台まで

サーバーコード

サーバーは数字の番号ではなく、S-7K2M-9QX4-HB3T のようなサーバーコードで区別します。サーバー一覧や作成レスポンスの id の値をそのままパスに入れてください。大文字と小文字は区別しません。

GET /catalog

販売中のスペック(plans)、リージョン(locations)、イメージ(images)、追加オプション(addons)をまとめて返します。サーバー作成時に指定するコードはすべてここから取得します。monthly は米ドルの月額料金で、販売していないオプションは null で返ります。追加ディスクの monthly_per_gb は小数点以下3桁まで表示されます。

リクエスト例

curl https://helpervps.com/api/v1/catalog \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンス例

{
  "plans": [
    { "code": "s2", "type": "basic", "vcpu": 1, "ram_mb": 2048, "disk_gb": 50, "transfer_tb": 2, "monthly": "2.48" }
  ],
  "locations": ["frankfurt", "singapore", "seoul"],
  "images": ["ubuntu-24-04", "debian-13", "almalinux-10", "app-docker"],
  "addons": {
    "backups": { "percent_of_plan": 5.6 },
    "extra_disk": { "sizes_gb": [50, 100, 250, 500, 1000], "monthly_per_gb": "0.028" },
    "ddos_protection": { "monthly": "1.68" }
  }
}

GET /servers

自分のサーバー一覧を、作成日の新しい順に返します。削除されたサーバーや作成できなかったサーバーは含まれません。

リクエスト例

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンス例

[
  {
    "id": "S-7K2M-9QX4-HB3T",
    "label": "web-1",
    "state": "running",
    "ipv4": "192.0.2.15",
    "ipv6": "2001:db8::15",
    "monthly": "2.48",
    "backups": false,
    "extra_disk_gb": 0,
    "ddos_protection": false,
    "paid_until": "2026-11-18T09:00:00.000Z"
  }
]

POST /servers

サーバーを作成し、支払いを処理します。plan、location、image にはカタログのコードをそのまま使用します。label は最大40文字のラテン文字、数字、ピリオド、ハイフンで、それ以外の文字はハイフンに置き換えられます。backups、extra_disk_gb、ddos_protection はオプションです。成功すると 201 とともにサーバーの詳細が返され、root_password はこのレスポンスに1回だけ含まれます(アカウントのサーバーページでも7日間確認できます)。

リクエスト例

curl -X POST https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plan":"s2","location":"frankfurt","image":"ubuntu-24-04","label":"web-1","backups":true,"extra_disk_gb":0,"ddos_protection":false}'

レスポンス例

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "creating",
  "ipv4": null,
  "ipv6": null,
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z",
  "root_password": "..."
}

GET /servers/{id}

1台のサーバーの状態、アドレス、月額料金、支払期限を返します。新しいサーバーは creating で始まり、準備が終わると running になって ipv4、ipv6 が入ります。数秒おきに確認すれば十分です。

リクエスト例

curl https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンス例

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "running",
  "ipv4": "192.0.2.15",
  "ipv6": "2001:db8::15",
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z"
}

POST /servers/{id}/start (stop, reboot)

start は停止中(stopped)のサーバーを起動し、stop と reboot は実行中(running)のサーバーを停止または再起動します。レスポンスは変更後のサーバー情報です。

リクエスト例

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/reboot \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンス例

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "rebooting",
  ...
}

POST /servers/{id}/renew

今すぐ支払って有効期間を延長します。有効期限後に停止したサーバーも、このリクエストで再び起動します。

リクエスト例

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/renew \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンス例

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "running",
  "paid_until": "2026-12-18T09:00:00.000Z",
  ...
}

DELETE /servers/{id}

サーバーとディスクを削除します。次の支払日から料金はかからず、すでに支払った月の残り期間は返金されません。

リクエスト例

curl -X DELETE https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンス例

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "deleted"
}

サーバーのレスポンスフィールド

id	サーバーコード(S-XXXX-XXXX-XXXX)。すべてのパスでこの値を使います。
label	サーバー名
state	creating、running、stopped、rebooting、installing、suspended、check のいずれか
ipv4, ipv6	サーバーのアドレス。準備前は null
monthly	オプションを含む月額料金(米ドル、文字列)
backups, extra_disk_gb, ddos_protection	選んだ追加オプション
paid_until	有効期限(UTC、ISO 8601)。この時点でサーバーが停止する場合があります。
root_password	作成レスポンスにのみ1回含まれます。

状態の値

creating	サーバーを作成中です。
running	実行中です。stop、reboot を使えます。
stopped	停止中です。start で起動します。
rebooting	再起動中です。
installing	再インストール中です。
suspended	有効期限終了後に停止しました。renew で再び起動します。
check	サーバーセットアップの結果を確認しています。サーバーが完成するか、支払いが返金されます。

エラー

エラーが起きると、ステータスコードとともに {"error": "コード"} 形式の JSON が返ります。コードの値で処理を分けてください。

401 unauthorized	API キーがないか、正しくありません。
403 not_allowed	API は最初の支払い後に利用可能になります。
400 bad_request	フィールドがないか、値が正しくありません。コードはカタログの値をそのまま使ってください。
402 not_enough_balance	支払いを完了してから、再度送信してください。
409 limit	アカウントで作成できるサーバー数の上限に達しました。
409 not_created	サーバーを作成できませんでした。支払いは返金されます。
202 checking	サーバーセットアップの結果を確認しています。同じリクエストを再送せず、サーバー一覧を確認してください。サーバーが完成するか、支払いが返金されます。
404 not_found	お使いのアカウントに該当するサーバーまたはパスがありません。
409 wrong_state	サーバーの現在の状態では実行できない操作です。
429 rate_limited	リクエスト制限に達しました。少し待ってから送ってください。

あわせて読みたいガイド

支払いは安全な PayGate チェックアウトを通じて行われます。アカウントのサーバーページで再インストールと新しい root パスワードを作成できます。手順は再インストールガイドにあります。

API でできることと自動化の例は VPS API ページで、スペック別の月額料金は料金ページで確認できます。