VPS.org API

Constellation name (optional)

Kiek API

Take labelled snapshots of a server, list them and delete the ones you no longer need.

Eindpunte 4
Basispad /api/v1/snapshots
KRY /api/v1/snapshots/

Lys alle momentopnames

Gee eers die foto's in jou rekening terug, nuutste eerste, 25 per bladsy.

Benodigde toestemming: snapshots:list

Voorbeeldversoek

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

Antwoordvelde

Veld Tipe Beskrywing
uuid string Kiekidentifiseerder (32 heksadesimaal karakters, geen hifens)
label string Etiket gegee toe die kiek geskep is
server_hostname string Gasheernaam van die bediener van die kiek is geneem, of nuller as daardie bediener nie meer bestaan nie
ready boolean Waar sodra die kiek klaar is
deleting boolean Waar terwyl 'n skraping aan die gang is
created_at datetime Skeppingstyd (Iso 8601, UTC)
size_gb number Saamgepersde grootte in gigante
KRY /api/v1/snapshots/{uuid}/

Kry 'n kiek

Sit een kiek voorwerp terug met die velde hierbo. Gebruik dit om reg te stem nadat 'n kiek geskep is.

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

Skep 'n Kiek

Wagtou 'n kiek van' n geneede bediener en gee terug die nuwe kiek se uuid. Die kiek word gelys direk weg met gereed stel na vals.

Benodigde toestemming: servers:snapshot

Versoekliggaamparameters

Parameter Tipe Vereis Beskrywing
action string Ja Moet kiek wees
snapshot_label string Ja 'n etiket om die kiek te herken
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"
}

Reaksiestatuskodes

200 Die aksie is getou
400 aksie of kiek_label ontbreek, of die bediener word nog nie gebruik nie
402 Geen betalingsmetode op lêer, of onbetaalde fakture,
404 Nie gevind nie, of dit behoort aan 'n ander rekening
VERWYDER /api/v1/snapshots/{uuid}/

Uitvee Kiek

Wagtou die kiek vir permanente skraping. Verwydering is waar totdat dit weg is.

Benodigde toestemming: snapshots:delete

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

Reaksiestatuskodes

202 Aanvaar: die versoek is getou
404 Nie gevind nie, of dit behoort aan 'n ander rekening

Notas