VPS.org API

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

बॅकअप API

सर्वर बॅकअपची यादी, नविन बॅकअप सुरू करा व सर्वर एक पासून पुन्हस्थापन करा.

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

सर्व बॅकअपची यादी करा

सर्व सर्वरचे बॅकअप परत करतो, नविन प्रथम, 25 प्रति पान. सर्वर फिल्टर नाही: त्यांना समूहबद्ध करण्याकरीता server_ hostname चा वापर करा.

आवश्यक परवानगी: backups:list

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

परिमाण प्रकार आवश्यक वर्णन@ title: window
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"
    }
  ]
}

प्रतिसाद फील्ड

क्षेत्र प्रकार वर्णन@ title: window
id integer बॅकअप ओळखकर्ता, get व restore endpoints द्वारे वापरले जाते
server_hostname string बॅकअप घेण्यासाठी वापरले गेलेले सर्वरचे यजमान नाव
name string बॅकअप आर्काइव फाइल नाव
size_gb number gigabytes अंतर्गत संकुचित आकार
deletion_date datetime बॅकअप स्वचलितपणे काढून टाकले जाईल तेव्हा
days_remaining integer काढूण टाकण्याजोगी दिनांक पर्यंत पूर्ण दिवस शिल्लक आहेत (_d)
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 आढळले नाही किंवा ते इतर खात्याशी संबंधित आहे

टिपण्णी