VPS.org API

Dokumentace k REST API

API pro zálohy

Spravujte zálohy serverů programově. Zobrazujte, vytvářejte, obnovujte a odstraňujte zálohy vašich serverů.

Koncové body 3 endpoints
Základní cesta /api/v1/backups
ZÍSKAT /api/v1/backups/

Zobrazit všechny zálohy

Získejte seznam všech záloh na vašich serverech.

Parametry dotazu

Parametr Typ Požadovaný Popis
server_id integer Žádný Filtrovat zálohy podle ID serveru
backup_type string Žádný Filtrovat podle typu: manual , automatic

Příklad žádosti

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říklad odpovědi

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

Kódy stavu odpovědi

200 Seznam záloh byl úspěšně načten
401 Neoprávněné – Neplatný nebo chybějící ověřovací token
ZVEŘEJNIT /api/v1/backups/

Vytvořit ruční zálohu

Vytvořte ruční zálohu serveru. Ruční zálohy nevyprší automaticky.

Parametry těla požadavku

Parametr Typ Požadovaný Popis
server_id integer Ano ID serveru pro zálohování
description string Žádný Volitelný popis zálohy

Příklad žádosti

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říklad odpovědi

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

Kódy stavu odpovědi

201 Vytváření zálohy bylo úspěšně zahájeno
400 Špatný požadavek – Neplatné parametry nebo chybně formátovaný požadavek
401 Neoprávněné – Neplatný nebo chybějící ověřovací token
404 Nenalezen - Server neexistuje
Poznámka: Na server můžete mít maximálně 10 ručních záloh. Automatické zálohy se uchovávají na základě zásad uchovávání záloh vašeho tarifu (obvykle 7–30 dní).
VYMAZAT /api/v1/backups/{backup_id}/

Smazat zálohu

Trvale smazat zálohu. Tuto akci nelze vrátit zpět.

Parametry cesty

Parametr Typ Požadovaný Popis
backup_id integer Ano Jedinečné ID zálohy

Příklad žádosti

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

Kódy stavu odpovědi

204 Záloha byla úspěšně smazána
401 Neoprávněné – Neplatný nebo chybějící ověřovací token
404 Nenalezeno - Záloha neexistuje
Varování: Smazání zálohy je trvalé a nelze jej vrátit zpět. Před smazáním se ujistěte, že tuto zálohu již nepotřebujete.

Obnovení ze záloh

Chcete-li obnovit server ze zálohy, použijte koncový bod obnovení rozhraní Servers API :

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

Podrobné informace o obnově serveru naleznete v Dokumentace k API serverů.

Nejlepší postupy zálohování