VPS.org API

REST API दस्तऐवजीकरण

स्नॅपशॉट्स API

जलद पॉइंट-इन-टाइम पुनर्संचयित करण्यासाठी सर्व्हर स्नॅपशॉट व्यवस्थापित करा. स्नॅपशॉट तुमच्या सर्व्हरची संपूर्ण स्थिती कॅप्चर करतात.

शेवटचे बिंदू 4 endpoints
बेस पाथ /api/v1/snapshots
मिळवा /api/v1/snapshots/

सर्व स्नॅपशॉट्सची यादी करा

तुमच्या सर्व्हरवरील सर्व स्नॅपशॉट्सची यादी मिळवा.

क्वेरी पॅरामीटर्स

पॅरामीटर प्रकार आवश्यक वर्णन
server_id integer नाही सर्व्हर आयडीनुसार स्नॅपशॉट फिल्टर करा

उदाहरण विनंती

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/

स्नॅपशॉट तयार करा

Create a snapshot of a server's current state. Snapshots are point-in-time copies of the entire server.

बॉडी पॅरामीटर्सची विनंती करा

पॅरामीटर प्रकार आवश्यक वर्णन
server_id integer होय स्नॅपशॉटसाठी सर्व्हरचा आयडी
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/

स्नॅपशॉटमधून रिस्टोअर करा

Restore a server to the state captured in a snapshot. This will overwrite all current data on the server.

पथ पॅरामीटर्स

पॅरामीटर प्रकार आवश्यक वर्णन
snapshot_id integer होय युनिक स्नॅपशॉट आयडी

उदाहरण विनंती

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 होय युनिक स्नॅपशॉट आयडी

उदाहरण विनंती

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

Understanding when to use snapshots versus 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

Best Practices