VPS.org API

REST API-dokumentation

Säkerhetskopierings-API

Lista serversäkerhetskopieringar, starta en ny säkerhetskopiering och återställa en server från en.

Slutpunkter 4
Basväg /api/v1/backups
FÅ /api/v1/backups/

Lista alla säkerhetskopior

Returnerar säkerhetskopiorna för alla dina servrar, nyaste först, 25 per sida. Det finns inget serverfilter: använd server_ värddatornamn för att gruppera dem.

Krav på tillstånd: backups:list

Frågeparametrar

Parameter Typ Nödvändig Varuslag
page integer Ej tillämpligt Sidnummer, med början på 1

Exempelförfrågan

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

Exempelsvar

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

Svarsfält

Fält Typ Varuslag
id integer Säkerhetskopieringsidentifierare, som används av få och återställa endpoints
server_hostname string Värddatornamn för servern som säkerhetskopian togs från
name string Arkivnamn för säkerhetskopiering
size_gb number Komprimerad storlek i gigabyte
deletion_date datetime När säkerhetskopian tas bort automatiskt
days_remaining integer Hela dagar kvar till radering_datum
created_at datetime Tid för skapande (ISO 8601, UTC)

Svarsstatuskoder

200 Hämtad säkerhetskopia med lyckat resultat
403 Saknas eller ogiltig API- token, eller token saknar den behörighet som krävs
FÅ /api/v1/backups/{id}/

Hämta en säkerhetskopia

Returnerar ett reservobjekt med fälten ovan.

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Från och med den 1 januari 2016 till och med den 31 december 2016 /api/v1/servers/{uuid}/backup/

Skapa en säkerhetskopia

Köar en säkerhetskopia av en utplacerad server. Inget förfrågningsorgan behövs. Säkerhetskopian visas i listan när den är klar, vilket kan ta flera minuter beroende på diskanvändning.

Krav på tillstånd: 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())

Exempelsvar

{
  "message": "Backup queued successfully"
}

Svarsstatuskoder

200 Åtgärden var köad
400 Servern är inte utplacerad ännu
402 Ingen betalningsmetod på fil eller obetald räkning
404 Inte hittat, eller det tillhör ett annat konto
Från och med den 1 januari 2016 till och med den 31 december 2016 /api/v1/backups/{id}/restore/

Återställ en server från en säkerhetskopiering

Stoppar servern som säkerhetskopieringen togs från, skriver över sin disk med säkerhetskopieringen och startar den igen. Inget förfrågningsorgan behövs. Serverstatusen är kö medan återställning körs.

Krav på tillstånd: 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"
}
Varning: Allt som skrivits till servern efter att säkerhetskopieringen tagits bort går förlorat. En återställning kan inte göras ogjord.

Svarsstatuskoder

200 Åtgärden var köad
400 Servern är inte utplacerad ännu
404 Inte hittat, eller det tillhör ett annat konto

Anmärkningar