VPS.org API

REST API-documentatie

Snapshots API

Neem de gelabelde snapshots van een server, vermeld ze en verwijder degenen die je niet meer nodig hebt.

Eindpunten 4
Basispad /api/v1/snapshots
KRIJGEN /api/v1/snapshots/

Alle momentopnamen weergeven

Geeft de snapshots terug in uw account, nieuwste eerst, 25 per pagina.

Vereiste toestemming: snapshots:list

Voorbeeldverzoek

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

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

response = requests.get(url, headers=headers)
for snapshot in response.json()["results"]:
    print(snapshot["uuid"], snapshot["label"], snapshot["ready"])
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

Voorbeeldantwoord

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b",
      "label": "before-upgrade",
      "server_hostname": "web-01",
      "ready": true,
      "deleting": false,
      "created_at": "2026-09-14T18:30:00.000000Z",
      "size_gb": 3.4
    }
  ]
}

Antwoordvelden

Veld Type Omschrijving
uuid string Snapshot-identificatie (32 hexadecimale tekens, geen koppeltekens)
label string Label gegeven bij het aanmaken van de snapshot
server_hostname string Hostnaam van de server waarvan de snapshot is genomen, of nul als die server niet meer bestaat
ready boolean Waar zodra de snapshot is voltooid
deleting boolean Waar terwijl een verwijdering is bezig
created_at datetime Creatietijd (ISO 8601, UTC)
size_gb number Gecomprimeerde grootte in gigabytes
KRIJGEN /api/v1/snapshots/{uuid}/

Een Snapshot halen

Geeft een snapshot-object terug met de velden hierboven. Gebruik het om te poll-klaar na het maken van een snapshot.

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
POST /api/v1/servers/{uuid}/snapshot/

Een Snapshot aanmaken

Wacht op een snapshot van een geïmplementeerde server en geeft de uuid van de nieuwe snapshot terug. De snapshot wordt direct weergegeven met klaar op onwaar.

Vereiste toestemming: servers:snapshot

Parameters van de aanvraagbody

Parameter Type Vereist Omschrijving
action string Ja Moet snapshot zijn
snapshot_label string Ja Een label om de snapshot te herkennen door
cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/snapshot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "snapshot", "snapshot_label": "before-upgrade"}'
import requests

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

response = requests.post(url, headers=headers, json=data)
print(response.json()["snapshot_uuid"])

Voorbeeldantwoord

{
  "message": "Snapshot queued successfully",
  "snapshot_uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b"
}

Responsstatuscodes

200 De actie werd in de wachtrij geplaatst
400 actie of snapshot_label ontbreekt, of 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
VERWIJDEREN /api/v1/snapshots/{uuid}/

Verwijderen van een Snapshot

Wacht op de snapshot voor permanente verwijdering. verwijderen is waar totdat het is verdwenen.

Vereiste toestemming: snapshots:delete

curl -X DELETE "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Snapshot deletion queued"
}

Responsstatuscodes

202 Aanvaard: het verzoek werd in de wachtrij geplaatst
404 Niet gevonden, of het behoort tot een andere account

Opmerkingen