VPS.org API

REST API- dokumentasjon

Sikkerhetskopierings-API

List opp tjenerens sikkerhetskopier, start en ny sikkerhetskopi og gjenopprett en tjener fra en.

Endepunkter 4
Basissti /api/v1/backups
BLI /api/v1/backups/

List opp alle sikkerhetskopier

Returnerer sikkerhetskopier for alle dine tjenere, nyeste først, 25 pr. side. Det er ikke noe tjenerfilter: bruk tjener_ vertsnavn for å gruppere dem.

Påkrevd tillatelse: backups:list

Spørringsparametere

Parameter Type Obligatorisk Beskrivelse
page integer Nei Sidenummer, fra 1.

Eksempelforespørsel

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

Eksempelsvar

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

Svarfelt

Felt Type Beskrivelse
id integer Sikkerhetskopi- identifikator, brukt av hente og gjenopprett endepunkter
server_hostname string Vertsnavn for tjeneren som sikkerhetskopien ble tatt fra
name string Navn på arkivfil for sikkerhetskopi
size_gb number Komprimert størrelse i gigabyte
deletion_date datetime Når sikkerhetskopien blir fjernet automatisk
days_remaining integer Hele dager igjen til slettedatoen
created_at datetime Opprettelsestid (ISO 8601, UTC)

Svarstatuskoder

200 Vellykket hentet sikkerhetskopiliste
403 Mangler eller er ugyldig API- symbol, eller symbolet mangler tillatelse
BLI /api/v1/backups/{id}/

Hent sikkerhetskopi

Returnerer ett objekt med feltene over.

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

Lag en sikkerhetskopi

Legger i kø en sikkerhetskopi av en brukt tjener. Det trengs ingen instans for forespørsel. Sikkerhetskopien vises i lista når den er ferdig, det kan ta flere minutter avhengig av diskbruk.

Påkrevd tillatelse: 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())

Eksempelsvar

{
  "message": "Backup queued successfully"
}

Svarstatuskoder

200 Handlinga ble satt i kø
400 Tjeneren er ikke skrudd på ennå
402 Ingen betalingsmetode for fil, eller ubetalte fakturaer
404 Ikke funnet, eller den tilhører en annen konto
POST /api/v1/backups/{id}/restore/

Gjenopprett en tjener fra en sikkerhetskopi

Stopper tjeneren som sikkerhetskopien ble tatt fra, overskriver disken med sikkerhetskopien og starter den på nytt. Det trengs ingen instans for forespørsel. Tjenerstatusen er kø mens gjenopprettingen kjører.

Påkrevd tillatelse: 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"
}
Advarsel: Alt som er skrevet til tjeneren etter at sikkerhetskopien er tatt, går tapt. En gjenoppretting kan ikke angres.

Svarstatuskoder

200 Handlinga ble satt i kø
400 Tjeneren er ikke skrudd på ennå
404 Ikke funnet, eller den tilhører en annen konto

Merknader