VPS.org API

REST API dokumentáció

Biztonsági mentések API

Programozottan kezelheti a szerverek biztonsági mentéseit. Listázhatja, létrehozhatja, visszaállíthatja és törölheti a szerverek biztonsági mentéseit.

Végpontok 3 endpoints
Alapút /api/v1/backups
KAP /api/v1/backups/

Összes biztonsági mentés listázása

Lekérheti a szerverein található összes biztonsági mentés listáját.

Lekérdezési paraméterek

Paraméter Típus Kívánt Leírás
server_id integer Nem Biztonsági mentések szűrése szerverazonosító szerint
backup_type string Nem Szűrés típus szerint: manual , automatic

Példa kérés

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);

Példaválasz

{
  "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"
    }
  ]
}

Válasz állapotkódok

200 A biztonsági mentések listájának lekérése sikeresen megtörtént.
401 Jogosulatlan - Érvénytelen vagy hiányzó hitelesítési token
POSTA /api/v1/backups/

Manuális biztonsági mentés létrehozása

Készítsen manuális biztonsági mentést egy szerverről. A manuális biztonsági mentések nem járnak le automatikusan.

Kérés törzsének paraméterei

Paraméter Típus Kívánt Leírás
server_id integer Igen A biztonsági mentéshez használt szerver azonosítója
description string Nem Opcionális leírás a biztonsági mentéshez

Példa kérés

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);

Példaválasz

{
  "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."
}

Válasz állapotkódok

201 A biztonsági mentés létrehozása sikeresen megkezdődött
400 Hibás kérés - Érvénytelen paraméterek vagy helytelenül formázott kérés
401 Jogosulatlan - Érvénytelen vagy hiányzó hitelesítési token
404 Nem található - A szerver nem létezik
Jegyzet: Szerverenként legfeljebb 10 manuális biztonsági mentést készíthet. Az automatikus biztonsági mentéseket a csomag biztonsági mentésmegőrzési szabályzata alapján őrzi meg a rendszer (általában 7-30 nap).
TÖRÖL /api/v1/backups/{backup_id}/

Biztonsági mentés törlése

Biztonsági mentés végleges törlése. Ez a művelet nem vonható vissza.

Útvonal paraméterei

Paraméter Típus Kívánt Leírás
backup_id integer Igen Egyedi biztonsági mentési azonosító

Példa kérés

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);

Válasz állapotkódok

204 A biztonsági mentés sikeresen törölve
401 Jogosulatlan - Érvénytelen vagy hiányzó hitelesítési token
404 Nem található - A biztonsági mentés nem létezik
Figyelmeztetés: A biztonsági mentés törlése végleges, és nem vonható vissza. Törlés előtt győződjön meg arról, hogy már nincs szüksége erre a biztonsági mentésre.

Visszaállítás biztonsági mentésekből

Egy kiszolgáló biztonsági mentésből történő visszaállításához használja a Servers API visszaállítási végpontját:

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

A szerver-helyreállítással kapcsolatos részletes információkért lásd a Szerverek API dokumentációja.

Biztonsági mentés ajánlott gyakorlatai