XServer API リファレンス ‐ VPS管理

認証中のAPIキー情報を取得

現在認証に使用しているAPIキーの情報を返します。有効期限と、キーに設定された各サービスの権限・操作対象を確認できます。

すべてのサービスで共通のエンドポイントです。APIキーの疎通確認や、鍵の有効期限が切れていないかの確認に利用できます。

各サービスの権限と操作対象は services に入ります。トップレベルの service_type / servername / permission_type は、旧来型のサーバーAPIキー（対象がサーバー1台のみのキー）との互換のために返される値で、新しいキーには含まれません。

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/me" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "expires_at": "2027-04-16 00:00:00",
  "services": {
    "vps": {
      "permission_type": "full",
      "target_mode": "selected",
      "targets": ["a1b2c3d4-5678-40ab-cdef-1234567890ab"],
      "allow_signup": true
    }
  }
}

API実行ログを取得

現在認証に使用しているAPIキー自身の実行ログを、新しい順に返します。すべてのサービスで共通のエンドポイントです。公開APIへのリクエストのメタデータ（メソッド・パス・ステータスコード・レスポンスタイム・接続元IPアドレス・実行日時）が対象で、リクエストボディとレスポンスボディは含まれません。

ログの保持期間は直近90日です。複数のフィルタを指定した場合は、すべての条件に一致するログを返します。count は検索結果の総件数ではなく、今回のレスポンスに含まれる件数です。has_more が true の場合は、next_cursor を次のリクエストの cursor にそのまま指定して続きを取得してください。

このAPIで取得できるのは、呼び出しに使用したAPIキー自身のログのみです。アカウント内の複数のAPIキーを横断したログは、APIキー管理画面の「実行ログ」で確認してください。APIキーに紐づけられない認証失敗のログは、このAPIの結果には含まれません。

クエリパラメータ

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/logs" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "logs": [
    {
      "method": "GET",
      "path": "/v1/vps/servers/a1b2c3d4-5678-40ab-cdef-1234567890ab",
      "status_code": 200,
      "response_time_ms": 12,
      "ip_address": "203.0.113.1",
      "created_at": "2026-08-20 10:00:00"
    }
  ],
  "count": 1,
  "limit": 50,
  "has_more": true,
  "next_cursor": "djE6MTIzNDU"
}

お申し込み可能なプラン・料金を取得

APIからお申し込み可能なプランと契約期間ごとの料金（税込）、お申し込みに指定できるOSイメージの一覧を返します。

APIキー設定でVPSの新規お申し込みが許可されていない場合は 403 FORBIDDEN になります。

一時的に新規お申し込みの受付を停止しているプランも、再開予定の提供対象プランであれば一覧に含まれます。一覧にあっても、受付停止中・メンテナンス中は dry_run・実申請とも 409 CAPACITY_UNAVAILABLE になります。現在の受付可否は、新規お申し込みAPIを dry_run=true で実行して確認してください。完全に提供を終了したプランは一覧から除外されます。

total_price は「その日にお申し込みした場合の初回のお支払い額」（当月の日割り分＋契約期間分・キャンペーン適用後）で、日によって変わります。新規お申し込みAPIの expected_total_price には、このAPIが返した対象プラン・契約期間の total_price を指定してください。

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/vps/plans" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "plans": [
    {
      "plan_id": "vps-2gb",
      "vps_type": "vps",
      "plan_name": "2GBプラン",
      "memory_mb": 2048,
      "vcpu": 3,
      "disk_gb": 50,
      "currency": "JPY",
      "periods": [
        { "months": 1, "total_price": 1190, "regular_total_price": 1190, "campaign_applied": false },
        { "months": 12, "total_price": 19386, "regular_total_price": 26317, "campaign_applied": true }
      ]
    }
  ],
  "os_images": [
    { "image_id": "vps_ubuntu2404", "name": "Ubuntu 24.04", "version": "24.04 (64bit)", "minimum_memory_mb": 1024 }
  ]
}

VPSを新規お申し込み

VPSの新規契約をお申し込みます。料金はプリペイド（前払い残高）から引き落とされます。残高が不足している場合はエラー（PAYMENT_REQUIRED）になります。

ご利用には、APIキーの設定で「このキーでVPSの新規お申し込みを許可する」を有効にしておく必要があります。この設定を有効にするには、プリペイドに20,000円以上の残高が必要です。また、操作範囲が「指定のVPSのみ」のAPIキーからは利用できません（403 FORBIDDEN）。

お申し込みできるのは VPS・ビジネスVPS（Linux 標準 OS）です。Windows Server・GPUサーバー・アプリケーションイメージ・保存イメージには対応していません。

dry_run が true の場合は、課金・契約作成を行わず、現在の受付可否を含む実行可否を検証します。お申し込み可能な場合は HTTP 200 で dry_run と total_price を返し、受け入れ可能なサーバーがない場合やメンテナンス中は 409 CAPACITY_UNAVAILABLE を返します。実申請には Idempotency-Key ヘッダーが必要です（UUID推奨）。

実申請はリクエスト内でお支払い・契約作成・サーバーの作成まで同期的に処理され、成功すると HTTP 200 で server（お申し込みしたVPSの情報）を返します。status が active の場合はすぐに利用できます。OSの初期設定が続いている場合は building、サーバー作成が保留された場合は setup_pending で返ります。いずれの場合もお申し込み・お支払いは完了しており、通常は自動で完了します。その後の状況はお申し込み状況確認API（GET /v1/vps/signup-status/{id}）で確認できます。

自動更新は既定で有効（プリペイドからの自動引き落とし）になります。無効にする場合は auto_renew に false を指定してください。自動更新にはプリペイド残高が必要です。更新時に残高が不足している場合は自動更新の設定が解除され、メールでお知らせします。

新規アカウントの作成には対応していません（APIキーを発行したアカウントへの契約追加のみ）。

リクエストヘッダー

リクエストボディ

リクエスト例

curl \
  -X POST \
  "https://api.xserver.ne.jp/v1/vps/servers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "vps-2gb",
    "period": 12,
    "image_id": "vps_ubuntu2404",
    "root_password": "MyPassw0rd-2026",
    "name": "",
    "ssh_key_name": "",
    "expected_total_price": 19386,
    "agree_to_terms": true,
    "partner_code": "",
    "dry_run": false
}'

レスポンスフィールド

レスポンス例

{
  "server": {
    "id": 40000360,
    "uuid": "a1b2c3d4-5678-40ab-cdef-1234567890ab",
    "name": "vps-2026-08-14-12-00-00",
    "status": "active",
    "expiry_date": "2027-08-31"
  }
}

レスポンスフィールド（dry_run=true の場合）

課金・契約作成を行わずに実行可否を検証した結果

レスポンス例（dry_run=true の場合）

{
  "dry_run": true,
  "total_price": 19386
}

お申し込み状況を確認

お申し込み後のサーバー作成状況を返します。新規お申し込みAPIのレスポンスの status が building・setup_pending だった場合の確認先です。

APIキー設定でVPSの新規お申し込みが許可されていない場合は 403 FORBIDDEN になります。

status が active になるとサーバーを利用できます。uuid が確定した後は、VPS詳細取得API（GET /v1/vps/servers/{uuid}）でも状態を確認できます。長時間 setup_pending のまま解消されない場合は、サポートまでお問い合わせください。

パスパラメータ

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/vps/signup-status/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "server": {
    "id": 40000360,
    "uuid": "a1b2c3d4-5678-40ab-cdef-1234567890ab",
    "name": "vps-2026-08-14-12-00-00",
    "status": "active",
    "expiry_date": "2027-08-31"
  }
}

VPS一覧を取得

ご契約中のVPSの一覧を返します。APIキーの対象が「指定のVPSのみ」の場合は、対象に設定されたVPSのみ返します。

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/vps/servers" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "servers": [
    {
      "uuid": "a1b2c3d4-5678-40ab-cdef-1234567890ab",
      "name": "web-server-01",
      "vps_type": "vps",
      "plan_name": "2GBプラン",
      "status": "active",
      "ip_address": "203.0.113.10",
      "os": "Ubuntu 24.04",
      "memo": "本番環境（監視対象）"
    }
  ]
}

VPS詳細を取得

指定したVPSの詳細（プラン・OS・IPアドレス・ホスト名・電源状態・メモ等）を返します。電源状態はリアルタイムの値を返します。

パスパラメータ

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "server": {
    "uuid": "a1b2c3d4-5678-40ab-cdef-1234567890ab",
    "name": "web-server-01",
    "vps_type": "vps",
    "status": "active",
    "plan": {
      "name": "2GBプラン",
      "vcpu": 3,
      "memory_gb": 2,
      "disk_gb": 50
    },
    "os": "Ubuntu 24.04",
    "application": null,
    "hostname": "vps-0123456789.xvps.ne.jp",
    "reverse_hostname": "vps-0123456789.xvps.ne.jp",
    "ip_address": "203.0.113.10",
    "power": {
      "status": "running"
    },
    "memo": "本番環境（監視対象）"
  }
}

メモを変更

VPSのメモを変更します。空文字を指定するとメモを削除します。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X PUT \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/memo" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "memo": "本番環境（監視対象）"
}'

レスポンスフィールド

レスポンス例

{
  "message": "メモを更新しました"
}

サーバー名を変更

VPSの名前（サーバー名）を変更します。VPSパネルに表示される名前と共通です。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X PUT \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/name" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-server-01"
}'

レスポンスフィールド

レスポンス例

{
  "message": "サーバー名を変更しました"
}

逆引きホスト名を変更

VPSのIPアドレスの逆引きホスト名（PTRレコード）を変更します。標準ホスト名を指定すると初期設定に戻ります。指定したホスト名のドメイン所有確認や正引きとの一致確認は行いません。メールサーバー用途などで利用する場合は、正引き（Aレコード）がこのVPSのIPアドレスへ向いていることもあわせてご確認ください。現在の設定値はVPS詳細API（GET /v1/vps/servers/{uuid}）の reverse_hostname で確認できます。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X PUT \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/reverse-dns" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "hostname": "mail.example.com"
}'

レスポンスフィールド

レスポンス例

{
  "message": "逆引きホスト名を変更しました"
}

電源状態を取得

VPSの現在の電源状態を返します。電源操作後の反映確認（ポーリング）にもこのAPIを使用します。

パスパラメータ

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/power" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "power": {
    "status": "running"
  }
}

VPSを起動

停止中のVPSを起動します。受け付け後の反映は非同期で行われます（「電源操作の反映について」を参照）。稼働中など、現在の電源状態で実行できない場合は 409 が返されます。レスポンスボディはありません。

パスパラメータ

リクエスト例

curl \
  -X POST \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/power/start" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンス例

HTTP/1.1 202 Accepted
Location: /v1/vps/servers/a1b2c3d4-5678-40ab-cdef-1234567890ab/power

VPSを再起動

VPSを再起動します。受け付け後の反映は非同期で行われます（「電源操作の反映について」を参照）。レスポンスボディはありません。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X POST \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/power/reboot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "force": false
}'

レスポンス例

HTTP/1.1 202 Accepted
Location: /v1/vps/servers/a1b2c3d4-5678-40ab-cdef-1234567890ab/power

VPSを停止

稼働中のVPSを停止します。受け付け後の反映は非同期で行われます（「電源操作の反映について」を参照）。OS上での正常なシャットダウンを行いたい場合は、OSにログインしてシャットダウンしてください。レスポンスボディはありません。

パスパラメータ

リクエスト例

curl \
  -X POST \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/power/stop" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンス例

HTTP/1.1 202 Accepted
Location: /v1/vps/servers/a1b2c3d4-5678-40ab-cdef-1234567890ab/power

パケットフィルター設定を取得

パケットフィルター全体の有効/無効と、設定済みルールの一覧を返します。

パスパラメータ

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/packet-filter" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "packet_filter": {
    "enabled": true,
    "rules": [
      {
        "id": 101,
        "type": "ssh",
        "protocol": null,
        "port": null,
        "allowed_ip": "all",
        "memo": null
      },
      {
        "id": 102,
        "type": "custom",
        "protocol": "tcp",
        "port": "8080",
        "allowed_ip": "203.0.113.0/24",
        "memo": "監視エージェント"
      }
    ]
  }
}

パケットフィルターの有効/無効を切替

パケットフィルター全体の有効/無効を切り替えます。無効にすると、設定済みルールにかかわらずすべてのポートへの接続が許可されます。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X PUT \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/packet-filter" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
}'

レスポンスフィールド

レスポンス例

{
  "message": "パケットフィルター設定を変更しました"
}

ルールを追加

パケットフィルターのルールを追加します。ルールは1台あたり最大20件で、同じ内容のルールは重複して追加できません（409 が返されます）。プリセット（custom 以外）は対象ポートが種別ごとに固定で、全てのIPアドレスからのアクセスを許可します（protocol / port / allowed_ip / memo は指定できず、指定した場合は 422 が返されます）。接続元IPアドレスを制限したい場合は type=custom で protocol / port / allowed_ip を指定してください。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X POST \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/packet-filter/rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "custom",
    "protocol": "tcp",
    "port": "8080",
    "allowed_ip": "203.0.113.0\/24",
    "memo": "監視エージェント"
}'

レスポンスフィールド

レスポンス例

{
  "rule": {
    "id": 102,
    "type": "custom",
    "protocol": "tcp",
    "port": "8080",
    "allowed_ip": "203.0.113.0/24",
    "memo": "監視エージェント"
  }
}

ルールを変更

カスタムルール（type=custom）の内容を変更します。protocol / port / allowed_ip / memo のうち1項目以上を指定してください。未指定の項目は現在値を維持します。プリセットのルールは変更できません（削除して追加し直してください）。protocol を icmp から tcp / udp に変更する場合は port も指定してください。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X PUT \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/packet-filter/rules/{rule_id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "protocol": "tcp",
    "port": "8080",
    "allowed_ip": "198.51.100.0\/24",
    "memo": "監視エージェント"
}'

レスポンスフィールド

レスポンス例

{
  "message": "パケットフィルタールールを変更しました"
}

ルールを削除

指定したパケットフィルターのルールを削除します。

パスパラメータ

リクエスト例

curl \
  -X DELETE \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/packet-filter/rules/{rule_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "message": "ルールを削除しました"
}

再インストールできるイメージ一覧を取得

OS再インストールで指定できるイメージの一覧を返します。ご契約中のプランで選択できるイメージのみが返るため、VPSパネルのOS再インストール画面と同じ内容です。

available_for_this_server が false のイメージは、このVPSでは選択できません（理由は unavailable_reason を参照）。requires_basic_password が true のイメージは、OS再インストールAPIで basic_password の指定が必要です。

パスパラメータ

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/os-images" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "os_images": [
    {
      "image_id": "vps_ubuntu2404",
      "name": "Ubuntu 24.04",
      "version": "24.04 (64bit)",
      "type": "os",
      "category": "ubuntu",
      "minimum_memory_mb": 1024,
      "requires_basic_password": false,
      "available_for_this_server": true,
      "unavailable_reason": null
    }
  ]
}

OSを再インストール

VPSのOSを再インストールします。指定したイメージでサーバーを作り直すため、サーバー内のデータ・設定はすべて削除されます。必要なデータは、あらかじめバックアップを取ったうえで実行してください。

実行にはVPSを停止しておく必要があります。稼働中の場合は 409（INVALID_POWER_STATE）が返されます。停止はVPS停止API（POST /v1/vps/servers/{uuid}/power/stop）で行えます。

誤操作を防ぐため、VPSごとに「操作保護」を設定できます。操作保護API（PUT /v1/vps/servers/{uuid}/protection）で os_reinstall を true にしたVPSに対しては 409（PROTECTED）が返され、再インストールは実行されません。あわせて、APIキーの権限を「カスタム」に設定すると「OS再インストール」だけを操作不可にできます。

指定できるイメージ・パスワードの条件はご契約中のプランによって異なります（「OS再インストールについて」を参照）。指定できるイメージはイメージ一覧API（GET /v1/vps/servers/{uuid}/os-images）で取得できます。

受け付け後の反映は非同期で行われます。レスポンスボディはありません。進捗はOS再インストール状況API（GET /v1/vps/servers/{uuid}/os-reinstall）で確認してください。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X POST \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/os-reinstall" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image_id": "vps_ubuntu2404",
    "root_password": "MyPassw0rd-2026"
}'

レスポンス例

HTTP/1.1 202 Accepted
Location: /v1/vps/servers/a1b2c3d4-5678-40ab-cdef-1234567890ab/os-reinstall

OS再インストールの状況を確認

OS再インストールの進行状況を返します。OS再インストールAPIを実行した後の確認先です（ポーリングの推奨間隔: 30秒程度）。

status が completed になるとサーバーを利用できます。進捗率は返しません。

パスパラメータ

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/os-reinstall" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "os_reinstall": {
    "status": "configuring",
    "image_id": "vps_ubuntu2404",
    "os": "Ubuntu 24.04",
    "installed_at": "2026-09-08 11:22:33"
  }
}

操作保護の設定を取得

VPSごとの操作保護の設定を返します。操作保護は、APIからの破壊的な操作をVPS単位で拒否するための設定です（VPSパネルからの操作には影響しません）。

現在は os_reinstall（OS再インストールの保護）のみです。有効なVPSに対してOS再インストールAPIを実行すると 409（PROTECTED）が返されます。

パスパラメータ

リクエスト例

curl \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/protection" \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスフィールド

レスポンス例

{
  "protection": {
    "os_reinstall": true
  }
}

操作保護の設定を変更

VPSごとの操作保護の設定を変更します。指定した項目のみ更新します。

os_reinstall を true にすると、そのVPSに対するOS再インストールAPIは 409（PROTECTED）で拒否されます。誤って再インストールしたくない本番サーバーや、自動化ツール・AIエージェントに操作させるVPSで有効にしておくことをおすすめします。再インストールする場合は、先に false へ戻してください。

パスパラメータ

リクエストボディ

リクエスト例

curl \
  -X PUT \
  "https://api.xserver.ne.jp/v1/vps/servers/{uuid}/protection" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "os_reinstall": true
}'

レスポンスフィールド

レスポンス例

{
  "message": "操作保護設定を変更しました"
}