VPS.org API

REST API-documentatie

Backups API

Geef uw back-ups van uw server weer, start een nieuwe back-up en herstel een server van één.

Eindpunten 4
Basispad /api/v1/backups
KRIJGEN /api/v1/backups/

Alle back-ups weergeven

Geeft de back-ups van al uw servers, de nieuwste eerst, 25 per pagina. Er is geen serverfilter: gebruik server_hostnaam om ze te groeperen.

Vereiste toestemming: backups:list

Queryparameters

Parameter Type Vereist Omschrijving
page integer Nee Paginanummer, te beginnen bij 1

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Antwoordvelden

Veld Type Omschrijving
id integer Backup-identificatie, gebruikt door de get-en-herstel eindpunten
server_hostname string Hostnaam van de server waarvan de back-up is genomen
name string Backup archiefbestandsnaam
size_gb number Gecomprimeerde grootte in gigabytes
deletion_date datetime Wanneer de back-up automatisch wordt verwijderd
days_remaining integer De hele dagen tot de verwijdering_datum
created_at datetime Creatietijd (ISO 8601, UTC)

Responsstatuscodes

200 Opgehaalde reservekopielijst succesvol
403 Ontbrekende of ongeldige API token, of het token mist de vereiste toestemming
KRIJGEN /api/v1/backups/{id}/

Een back-up halen

Geeft een back-up object terug met de velden hierboven.

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

Een reservekopie maken

Wacht een back-up van een geïmplementeerde server af. Er is geen verzoektekst nodig. De back-up verschijnt in de lijst zodra deze is voltooid, wat enkele minuten kan duren afhankelijk van het gebruik van de schijf.

Vereiste toestemming: 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())

Voorbeeldantwoord

{
  "message": "Backup queued successfully"
}

Responsstatuscodes

200 De actie werd in de wachtrij geplaatst
400 De server is nog niet geïmplementeerd
402 Geen betalingsmethode in het dossier, of onbetaalde facturen
404 Niet gevonden, of het behoort tot een andere account
POST /api/v1/backups/{id}/restore/

Een server herstellen uit een back-up

Stopt de server waar de back-up van werd genomen, overschrijft de schijf met de back-up en start deze opnieuw. Er is geen request-inhoud nodig. De serverstatus is wachtrij terwijl de restore draait.

Vereiste toestemming: 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"
}
Waarschuwing: Alles wat naar de server is geschreven nadat de back-up is gemaakt, is verloren gegaan. Een herstel kan niet ongedaan worden gemaakt.

Responsstatuscodes

200 De actie werd in de wachtrij geplaatst
400 De server is nog niet geïmplementeerd
404 Niet gevonden, of het behoort tot een andere account

Opmerkingen