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 हो ब्याकअप गर्नुपर्ने सर्भरको आईडी
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 हो अद्वितीय ब्याकअप 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 फेला परेन - ब्याकअप अवस्थित छैन
चेतावनी: ब्याकअप मेटाउनु स्थायी हुन्छ र यसलाई पूर्ववत गर्न सकिँदैन। यसलाई मेटाउनु अघि तपाईंलाई अब यो ब्याकअपको आवश्यकता छैन भनी सुनिश्चित गर्नुहोस्।

ब्याकअपबाट पुनर्स्थापना गर्दै

ब्याकअपबाट सर्भर पुनर्स्थापना गर्न, सर्भर API पुनर्स्थापना अन्त्य बिन्दु प्रयोग गर्नुहोस्:

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

सर्भर पुनर्स्थापनाको बारेमा विस्तृत जानकारीको लागि, हेर्नुहोस् सर्भर API कागजातहरू.

ब्याकअप उत्तम अभ्यासहरू