スナップショットAPI

得る /api/v1/snapshots/

すべてのスナップショットを一覧表示

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

クエリパラメータ

パラメータ	タイプ	必須	説明
`server_id`	integer	いや	サーバーIDでスナップショットをフィルタリングする

リクエスト例

cURL

Python

JavaScript

curl -X GET "https://admin.vps.org/api/v1/snapshots/?server_id=12345" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/snapshots/"
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/snapshots/?server_id=12345', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

回答例

{
  "count": 2,
  "results": [
    {
      "id": 801,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "name": "pre-migration-snapshot",
      "status": "completed",
      "size_mb": 5120,
      "created_at": "2025-01-15T18:30:00Z",
      "description": "Before major migration"
    },
    {
      "id": 798,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "name": "weekly-snapshot-2025-01-08",
      "status": "completed",
      "size_mb": 4856,
      "created_at": "2025-01-08T12:00:00Z",
      "description": "Weekly snapshot"
    }
  ]
}

応答ステータスコード

200	スナップショットリストを正常に取得しました
401	認証されていません - 認証トークンが無効または見つかりません

ポスト /api/v1/snapshots/

スナップショットを作成

サーバの現在の状態のスナップショットを作成します。スナップショットはサーバ全体のタイムポイントコピーです。

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

パラメータ	タイプ	必須	説明
`server_id`	integer	はい	スナップショットするサーバーのID
`name`	string	はい	スナップショットの名前（英数字、ハイフン、アンダースコア）
`description`	string	いや	スナップショットのオプションの説明

リクエスト例

cURL

Python

JavaScript

curl -X POST "https://admin.vps.org/api/v1/snapshots/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": 12345,
    "name": "before-update-snapshot",
    "description": "Snapshot before system update"
  }'

import requests

url = "https://admin.vps.org/api/v1/snapshots/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "server_id": 12345,
    "name": "before-update-snapshot",
    "description": "Snapshot before system update"
}

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

const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    server_id: 12345,
    name: 'before-update-snapshot',
    description: 'Snapshot before system update'
  })
});

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

回答例

{
  "id": 802,
  "server": {
    "id": 12345,
    "name": "web-server-01"
  },
  "name": "before-update-snapshot",
  "status": "in_progress",
  "size_mb": null,
  "created_at": "2025-01-16T16:15:00Z",
  "description": "Snapshot before system update",
  "message": "Snapshot is being created. This may take 3-10 minutes depending on server size."
}

応答ステータスコード

201	スナップショットの作成が正常に開始されました
400	Bad Request - Invalid parameters or snapshot limit reached
401	認証されていません - 認証トークンが無効または見つかりません
404	Not Found - Server does not exist

注意: You can have a maximum of 5 snapshots per server. Creating a snapshot while the server is running may result in filesystem inconsistencies. For best results, stop the server before creating a snapshot.

ポスト /api/v1/snapshots/{snapshot_id}/restore/

スナップショットからの復元

スナップショットで撮影された状態にサーバを復元します。サーバ上のすべての現在のデータを上書きします。

パスパラメータ

パラメータ	タイプ	必須	説明
`snapshot_id`	integer	はい	一意のスナップショットID

リクエスト例

cURL

Python

JavaScript

curl -X POST "https://admin.vps.org/api/v1/snapshots/801/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

snapshot_id = 801
url = f"https://admin.vps.org/api/v1/snapshots/{snapshot_id}/restore/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

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

const snapshotId = 801;
const response = await fetch(`https://admin.vps.org/api/v1/snapshots/${snapshotId}/restore/`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

回答例

{
  "status": "success",
  "message": "Server is being restored from snapshot. This may take 5-15 minutes.",
  "snapshot": {
    "id": 801,
    "name": "pre-migration-snapshot",
    "created_at": "2025-01-15T18:30:00Z"
  },
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "restoring"
  }
}

応答ステータスコード

200	復元が正常に開始されました
400	Bad Request - Server is not in a valid state for restoration
401	認証されていません - 認証トークンが無効または見つかりません
404	見つかりません - スナップショットが存在しません

警告： Restoring from a snapshot will overwrite all current data on the server. This action cannot be undone. The server will be automatically stopped before restoration begins.

消去 /api/v1/snapshots/{snapshot_id}/

スナップショットを削除

スナップショットを完全に削除します。この操作は元に戻せません。

パスパラメータ

パラメータ	タイプ	必須	説明
`snapshot_id`	integer	はい	一意のスナップショットID

リクエスト例

cURL

Python

curl -X DELETE "https://admin.vps.org/api/v1/snapshots/801/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

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

response = requests.delete(url, headers=headers)
print(response.status_code)

応答ステータスコード

204	スナップショットが正常に削除されました
401	認証されていません - 認証トークンが無効または見つかりません
404	見つかりません - スナップショットが存在しません

Snapshots vs Backups

スナップショットとバックアップの違いを理解する:

スナップショットAPI

目的： Quick point-in-time recovery
スピード： Faster to create and restore (3-15 min)
使用事例： Before risky operations (updates, config changes)
ストレージ： Stored on same infrastructure
制限: 5 snapshots per server
最適な用途: Short-term rollback capability

バックアップAPI

目的： Long-term data protection
スピード： Slower to create and restore (varies)
使用事例： Regular automated data protection
ストレージ： Separate backup storage
制限: 10 manual + automatic backups
最適な用途: Disaster recovery and compliance

ベストプラクティス

更新前: システムの主要なアップデートの前にスナップショットを作成します
テスト: 設定変更をテストするときはスナップショットを使う(T)
組み合わせ戦略: スナップショット (短期) とバックアップ (長期) を使用
クリーンアップ: 更新に成功した後に古いスナップショットを削除する
サーバの状態: 重要なスナップショットを作成する前にサーバを停止するか検討してください

VPS.org API

スナップショットAPI

すべてのスナップショットを一覧表示

クエリパラメータ

リクエスト例

回答例

応答ステータスコード

スナップショットを作成

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

リクエスト例

回答例

応答ステータスコード

スナップショットからの復元

パスパラメータ

リクエスト例

回答例

応答ステータスコード

スナップショットを削除

パスパラメータ

リクエスト例

応答ステータスコード

Snapshots vs Backups

スナップショットAPI

バックアップAPI

ベストプラクティス