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 అవును బ్యాకప్ చేయడానికి సర్వర్ ID
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 కనుగొనబడలేదు - సర్వర్ ఉనికిలో లేదు.
గమనిక: మీరు ఒక్కో సర్వర్‌కు గరిష్టంగా 10 మాన్యువల్ బ్యాకప్‌లను కలిగి ఉండవచ్చు. మీ ప్లాన్ యొక్క బ్యాకప్ నిలుపుదల విధానం (సాధారణంగా 7-30 రోజులు) ఆధారంగా ఆటోమేటిక్ బ్యాకప్‌లు నిలుపుకోబడతాయి.
తొలగించు /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 డాక్యుమెంటేషన్.

బ్యాకప్ ఉత్తమ పద్ధతులు