VPS.org API

REST API Documentation

Snapshots API

Tag mærkede snapshots af en server, liste dem og slette dem, du ikke længere har brug for.

Endepunkter 4
Basissti /api/v1/snapshots
FÅ /api/v1/snapshots/

Vis alle snapshots

Returnerer øjebliksbillederne på din konto, nyeste første, 25 pr. side.

Krævet tilladelse: snapshots:list

Eksempel på anmodning

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

Eksempel på svar

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

Svarfelter

Felt Type Description
uuid string Snapshot-identifikator (32 hexadecimale tegn, ingen bindestreger)
label string Etiket givet, når snapshot blev oprettet
server_hostname string Værtsnavn på serveren, snapshottet blev taget fra, eller null, hvis serveren ikke længere eksisterer
ready boolean Sandt, når snapshottet er færdigt
deleting boolean Sandt mens en sletning er i gang
created_at datetime Skabelsestid (ISO 8601, UTC)
size_gb number Komprimeret størrelse i gigabyte
FÅ /api/v1/snapshots/{uuid}/

Få et billede

Returnerer et øjebliksbillede objekt med felterne ovenfor. Brug det til at foretage meningsmåling klar efter at have oprettet et øjebliksbillede.

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

Opret et billede

Køer et øjebliksbillede af en indsat server og returnerer det nye øjebliksbilledes uuid. Snapshottet er angivet med det samme med klar indstillet til falsk.

Krævet tilladelse: servers:snapshot

Parametre for anmodningstekst

Parameter Type Påkrævet Description
action string Ja Det må være et øjebliksbillede
snapshot_label string Ja En etiket til at genkende snapshot ved
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"])

Eksempel på svar

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

Svarstatuskoder

200 Handlingen blev i kø
400 handling eller snapshot_label mangler, eller serveren er ikke indsat endnu
402 Ingen betalingsmetode for aktuar eller ubetalte fakturaer
404 Ikke fundet, eller det tilhører en anden konto
SLET /api/v1/snapshots/{uuid}/

Slet et snapshot

Køer snapshot for permanent sletning. sletning er sandt, indtil det er væk.

Krævet tilladelse: snapshots:delete

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

Svarstatuskoder

202 Accepteret: Anmodningen blev i kø
404 Ikke fundet, eller det tilhører en anden konto

Bemærkninger