VPS.org API

Dokumentace REST API

API pro zálohy

Vyberte si zálohu serveru, spusťte novou zálohu a z ní obnovte server.

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

Zobrazit všechny zálohy

Vrací zálohy všech vašich serverů, nejnovějších prvních, 25 na stránku. Neexistuje žádný serverový filtr: použijte server_hostname pro jejich seskupení.

Požadované povolení: backups:list

Parametry dotazu

Parametr Typ Požadovaný Popis zboží
page integer Ne. Číslo stránky, začínáme od 1

Příklad žádosti

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for backup in response.json()["results"]:
    print(backup["id"], backup["server_hostname"], backup["created_at"])
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

Příklad odpovědi

{
  "count": 96,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [
    {
      "id": 5512,
      "server_hostname": "web-01",
      "name": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
      "size_gb": 3.12,
      "deletion_date": "2026-09-21T20:45:40.697512Z",
      "days_remaining": 6,
      "created_at": "2026-09-14T20:45:40.699494Z"
    }
  ]
}

Pole odpovědí

Pole Typ Popis zboží
id integer Identifikátor zálohy, který používá cíl "získat a obnovit"
server_hostname string Jméno serveru, ze kterého byla záloha převzata
name string Název archivu záloh
size_gb number Stlačená velikost v gigabytech
deletion_date datetime Když bude záloha automaticky odstraněna
days_remaining integer Celé dny do data smazání
created_at datetime Doba vytvoření (ISO 8601, UTC)

Kódy stavu odpovědi

200 Úspěšně se našel seznam záloh
403 Chybí nebo neplatná API žeton, nebo žeton postrádá požadované povolení
ZÍSKAT /api/v1/backups/{id}/

Sežeň si zálohu.

Vrací jeden záložní objekt s výše uvedenými poli.

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
POST /api/v1/servers/{uuid}/backup/

Vytvořit zálohu

Po dokončení fronty se nastaví záloha na nasazeném serveru. Není potřeba žádat tělo. Záloha se objeví v seznamu, který může trvat několik minut v závislosti na použití disku.

Požadované povolení: servers:backup

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/backup/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/backup/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

Příklad odpovědi

{
  "message": "Backup queued successfully"
}

Kódy stavu odpovědi

200 Akce byla ve frontě.
400 Server ještě není nasazen.
402 Žádná platební metoda ve spisu nebo nezaplacené faktury
404 Nenalezeno, nebo patří k jinému účtu
POST /api/v1/backups/{id}/restore/

Obnovit server ze zálohy

Zastaví server, ze kterého byla záloha převzata, přepíše svůj disk zálohou a znovu jej spustí. Není potřeba žádné tělo požadavku. Stav serveru je frontou, zatímco se obnovuje.

Požadované povolení: backups:restore

curl -X POST "https://admin.vps.org/api/v1/backups/5512/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Backup restore queued. The server will be stopped, restored, and restarted.",
  "backup": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}
Varování: Vše napsané na serveru po převzetí zálohy je ztraceno. Obnova nelze zrušit.

Kódy stavu odpovědi

200 Akce byla ve frontě.
400 Server ještě není nasazen.
404 Nenalezeno, nebo patří k jinému účtu

Poznámky