VPS.org API

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

बॅकअप API

सर्व्हर बॅकअप प्रोग्रामॅटिकली व्यवस्थापित करा. तुमच्या सर्व्हरसाठी बॅकअप सूचीबद्ध करा, तयार करा, पुनर्संचयित करा आणि हटवा.

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

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

तुमच्या सर्व्हरवरील सर्व बॅकअपची यादी मिळवा.

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

पॅरामीटर प्रकार आवश्यक वर्णन
server_id integer नाही सर्व्हर आयडीनुसार बॅकअप फिल्टर करा
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 होय बॅकअप घेण्यासाठी सर्व्हरचा आयडी
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 सापडले नाही - सर्व्हर अस्तित्वात नाही.
टीप: तुमच्याकडे प्रत्येक सर्व्हरवर जास्तीत जास्त १० मॅन्युअल बॅकअप असू शकतात. तुमच्या प्लॅनच्या बॅकअप रिटेन्शन पॉलिसीनुसार (सामान्यतः ७-३० दिवस) स्वयंचलित बॅकअप राखले जातात.
हटवा /api/v1/backups/{backup_id}/

बॅकअप हटवा

बॅकअप कायमचा हटवा. ही क्रिया पूर्ववत करता येणार नाही.

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

पॅरामीटर प्रकार आवश्यक वर्णन
backup_id integer होय युनिक बॅकअप आयडी

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

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 सापडले नाही - बॅकअप अस्तित्वात नाही.
चेतावणी: बॅकअप हटवणे कायमचे असते आणि ते पूर्ववत करता येत नाही. ते हटवण्यापूर्वी तुम्हाला या बॅकअपची आवश्यकता नाही याची खात्री करा.

बॅकअपमधून पुनर्संचयित करत आहे

बॅकअपमधून सर्व्हर रिस्टोअर करण्यासाठी, सर्व्हर्स एपीआय रिस्टोअर एंडपॉइंट वापरा: 

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

सर्व्हर पुनर्संचयित करण्याबद्दल तपशीलवार माहितीसाठी, पहा सर्व्हर API दस्तऐवजीकरण.

बॅकअप सर्वोत्तम पद्धती