VPS.org API

REST APIドキュメント

バックアップAPI

サーバのバックアップを表示し、新しいバックアップを開始し、バックアップからサーバを復元します。

エンドポイント 4
ベースパス /api/v1/backups
得る /api/v1/backups/

すべてのバックアップを一覧表示する

すべてのサーバのバックアップを返します。最新のものを先に、ページごとに 25 個表示します。サーバフィルタはありません。グループ化するには server_hostname を使用してください。

必要な権限: backups:list

クエリパラメータ

パラメータ タイプ 必須 説明
page integer いや ページ番号、1 から始まる

リクエスト例

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for backup in response.json()["results"]:
    print(backup["id"], backup["server_hostname"], backup["created_at"])
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

回答例

{
  "count": 96,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [
    {
      "id": 5512,
      "server_hostname": "web-01",
      "name": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
      "size_gb": 3.12,
      "deletion_date": "2026-09-21T20:45:40.697512Z",
      "days_remaining": 6,
      "created_at": "2026-09-14T20:45:40.699494Z"
    }
  ]
}

応答フィールド

フィールド タイプ 説明
id integer バックアップ識別子、ゲットとリスタイルエンドポイントで使用
server_hostname string バックアップを取ったサーバのホスト名
name string バックアップアーカイブのファイル名
size_gb number 圧縮サイズ (ギガバイト)
deletion_date datetime バックアップを自動的に削除する時期
days_remaining integer 削除日までの残り日数
created_at datetime 作成時刻 (ISO 8601, UTC)

応答ステータスコード

200 バックアップリストを復元しました
403 API トークンが無効か欠けています。または、トークンには必要な権限がありません。
得る /api/v1/backups/{id}/

バックアップを取得

上記のフィールドを持つバックアップオブジェクトを返します。

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
ポスト /api/v1/servers/{uuid}/backup/

バックアップを作成

配置されたサーバのバックアップをキューに追加します。要求ボディは必要ありません。バックアップは完了したらリストに表示されます。ディスク使用量により数分かかる場合があります。

必要な権限: servers:backup

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/backup/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/backup/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

回答例

{
  "message": "Backup queued successfully"
}

応答ステータスコード

200 アクションがキューに入っています
400 サーバはまだ配置されていません
402 ファイルに支払方法がありませんか? または未払い請求書ですか?
404 見つかりませんでした。あるいは、他のアカウントに属しています。
ポスト /api/v1/backups/{id}/restore/

バックアップからサーバを復元

バックアップを取ったサーバを停止し、バックアップでディスクを上書きし、再起動します。要求ボディは必要ありません。復元が実行されている間は、サーバの状態はキューです。

必要な権限: backups:restore

curl -X POST "https://admin.vps.org/api/v1/backups/5512/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Backup restore queued. The server will be stopped, restored, and restarted.",
  "backup": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}
警告: バックアップを取った後にサーバに書き込んだすべてのデータは失われます。復元は無効にできます。

応答ステータスコード

200 アクションがキューに入っています
400 サーバはまだ配置されていません
404 見つかりませんでした。あるいは、他のアカウントに属しています。

ノート