VPS.org API

REST APIドキュメント

バックアップAPI

サーバーのバックアップをプログラムで管理します。サーバーのバックアップを一覧表示、作成、復元、削除できます。

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

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

サーバー全体のすべてのバックアップのリストを取得します。

クエリパラメータ

パラメータ タイプ 必須 説明
server_id integer いいえ サーバーIDでバックアップをフィルタリングする
backup_type string いいえ タイプでフィルタリング: manual 、 automatic

リクエスト例

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/?server_id=12345" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
params = {"server_id": 12345}

response = requests.get(url, headers=headers, params=params)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/?server_id=12345', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const backups = await response.json();
console.log(backups);

回答例

{
  "count": 3,
  "results": [
    {
      "id": 501,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4523,
      "created_at": "2025-01-16T03:00:00Z",
      "expires_at": "2025-02-16T03:00:00Z",
      "description": "Automatic daily backup"
    },
    {
      "id": 499,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "manual",
      "status": "completed",
      "size_mb": 4456,
      "created_at": "2025-01-14T10:30:00Z",
      "expires_at": null,
      "description": "Pre-update backup"
    },
    {
      "id": 495,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4389,
      "created_at": "2025-01-15T03:00:00Z",
      "expires_at": "2025-02-15T03:00:00Z",
      "description": "Automatic daily backup"
    }
  ]
}

応答ステータスコード

200 バックアップリストを正常に取得しました
401 認証されていません - 認証トークンが無効または見つかりません
役職 /api/v1/backups/

手動バックアップを作成する

サーバーの手動バックアップを作成します。手動バックアップは自動的に期限切れになることはありません。

リクエストボディパラメータ

パラメータ タイプ 必須 説明
server_id integer はい バックアップするサーバーのID
description string いいえ バックアップの説明（オプション）

リクエスト例

cURL
Python
JavaScript
PHP
curl -X POST "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": 12345,
    "description": "Pre-deployment backup"
  }'
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "server_id": 12345,
    "description": "Pre-deployment backup"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    server_id: 12345,
    description: 'Pre-deployment backup'
  })
});

const backup = await response.json();
console.log(backup);
$data = [
    'server_id' => 12345,
    'description' => 'Pre-deployment backup'
];

$ch = curl_init('https://admin.vps.org/api/v1/backups/');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$backup = json_decode($response, true);
curl_close($ch);

回答例

{
  "id": 502,
  "server": {
    "id": 12345,
    "name": "web-server-01"
  },
  "backup_type": "manual",
  "status": "in_progress",
  "size_mb": null,
  "created_at": "2025-01-16T15:45:00Z",
  "expires_at": null,
  "description": "Pre-deployment backup",
  "message": "Backup is being created. This may take several minutes depending on server size."
}

応答ステータスコード

201 バックアップの作成が正常に開始されました
400 不正なリクエスト - 無効なパラメータまたは不正なリクエスト
401 認証されていません - 認証トークンが無効または見つかりません
404 見つかりません - サーバーが存在しません
注記： サーバーごとに最大10件の手動バックアップを作成できます。自動バックアップは、プランのバックアップ保持ポリシー（通常は7～30日）に基づいて保持されます。
消去 /api/v1/backups/{backup_id}/

バックアップを削除

バックアップを完全に削除します。この操作は元に戻せません。

パスパラメータ

パラメータ タイプ 必須 説明
backup_id integer はい 一意のバックアップID

リクエスト例

cURL
Python
JavaScript
curl -X DELETE "https://admin.vps.org/api/v1/backups/501/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

backup_id = 501
url = f"https://admin.vps.org/api/v1/backups/{backup_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)
const backupId = 501;
const response = await fetch(`https://admin.vps.org/api/v1/backups/${backupId}/`, {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

console.log(response.status);

応答ステータスコード

204 バックアップが正常に削除されました
401 認証されていません - 認証トークンが無効または見つかりません
404 見つかりません - バックアップが存在しません
警告： バックアップを削除すると元に戻すことはできません。削除する前に、このバックアップが不要であることをご確認ください。

バックアップからの復元

バックアップからサーバーを復元するには、 Servers API復元エンドポイントを使用します。 

POST /api/v1/servers/{server_id}/restore/
{
  "backup_id": 501
}

サーバーの復旧に関する詳細は、 サーバーAPIドキュメント.

バックアップのベストプラクティス