VPS.org API

REST API Documentation

Backups API

Liste din server backups, starte en ny backup og gendanne en server fra en.

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

Liste over alle sikkerhedskopier

Returnerer sikkerhedskopier af alle dine servere, nyeste først, 25 pr. side. Der er ingen serverfilter: brug server_ hostname til at gruppere dem.

Krævet tilladelse: backups:list

Forespørgselsparametre

Parameter Type Påkrævet Description
page integer No Sidenummer, begyndende kl. 1

Eksempel på anmodning

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

Eksempel på svar

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

Svarfelter

Felt Type Description
id integer Sikkerhedskopieringsidentifikator, der anvendes af get og gendanne endpoints
server_hostname string Værtsnavn på serveren, backup blev taget fra
name string Backup arkiv filnavn
size_gb number Komprimeret størrelse i gigabyte
deletion_date datetime Når sikkerhedskopien fjernes automatisk
days_remaining integer Hele dage tilbage indtil sletning_date
created_at datetime Skabelsestid (ISO 8601, UTC)

Svarstatuskoder

200 List til sikkerhedskopiering med succes
403 Manglende eller ugyldig API token, eller den token mangler den krævede tilladelse
/api/v1/backups/{id}/

Få en sikkerhedskopi

Returnerer et sikkerhedskopiobjekt med felterne ovenfor.

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

Opret en sikkerhedskopi

Køer en sikkerhedskopi af en indsat server. Der er ikke brug for en forespørgselskrop. Sikkerhedskopien vises på listen når den er færdig, hvilket kan tage flere minutter afhængigt af diskforbrug.

Krævet tilladelse: 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())

Eksempel på svar

{
  "message": "Backup queued successfully"
}

Svarstatuskoder

200 Handlingen blev i kø
400 Serveren er ikke indsat endnu
402 Ingen betalingsmetode for aktuar eller ubetalte fakturaer
404 Ikke fundet, eller det tilhører en anden konto
POST /api/v1/backups/{id}/restore/

Gendan en server fra en sikkerhedskopi

Stoppede serveren sikkerhedskopien blev taget fra, overskriver dens disk med backup og starter den igen. Ingen anmodning krop er nødvendig. Serverstatus er kø mens gendannelse kører.

Krævet tilladelse: 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 skrevet til serveren efter backup blev taget er tabt. En gendannelse kan ikke fortrydes.

Svarstatuskoder

200 Handlingen blev i kø
400 Serveren er ikke indsat endnu
404 Ikke fundet, eller det tilhører en anden konto

Bemærkninger