VPS.org API

Dokumintaasje

Snapshots API

Nim foto's mei in label fan in tsjinner, list se en wiskje dy't jo net mear nedich binne.

Einpunten 4
Basispaad /api/v1/snapshots
KRIJE /api/v1/snapshots/

List alle snapshots

Jout de foto' s werom yn jo akkount, de lêste earst, 25 per side.

Tagongsrjochten fereaske: snapshots:list

Foarbyldfersyk

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

Foarbyldantwurd

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

Antwurdfjilden

Fjild Type Beskriuwing
uuid string Foto- identifier (32 heksadesimale tekens, gjin bindestreken)
label string Label jûn doe't de ôfbylding makke waard
server_hostname string Hostnamme fan de tsjinner wêrfan de foto makke is, of null as dy tsjinner net mear bestiet
ready boolean Wier as de snapshot klear is
deleting boolean Wier as in wiskje yn beweging is
created_at datetime Oanmaktiid (ISO 8601, UTC)
size_gb number Komprimearre grutte yn gigabytes
KRIJE /api/v1/snapshots/{uuid}/

In foto meitsje

Jout in snapshot- objekt werom mei de boppesteande fjilden. Brûk dit om te besykjen om klear te wêzen nei it oanmeitsjen fan in snapshot.

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

In foto oanmeitsje

Set in skyfke fan in ynset tsjinner yn de wachtrige en jout de uuid fan it nije skyfke werom. It skyfke wurdt direkt werjûn mei ready ynsteld op false.

Tagongsrjochten fereaske: servers:snapshot

Parameters fan oanfraachlichem

Parameters Type Ferplicht Beskriuwing
action string Ja Moat in snapshot wêze
snapshot_label string Ja In label om de foto mei te identifisearjen
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"])

Foarbyldantwurd

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

Antwurdstatuskoades

200 De aksje is yn de wachtrige set
400 action of snapshot_ label ûntbrekt, of de tsjinner is noch net ynset
402 Gjin betellingsmethode yn triem, of net- betelle faktueren
404 Net fûn, of it heart by in oar akkount
WISKE /api/v1/snapshots/{uuid}/

In foto wiskje

Set de foto yn de wachtrige foar it permanent wiskje. it wiskje is wier oant it fuort is.

Tagongsrjochten fereaske: snapshots:delete

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

Antwurdstatuskoades

202 Oannommen: it fersyk is yn de wachtrige set
404 Net fûn, of it heart by in oar akkount

Notysje