VPS.org API

REST API- dokumentasjon

API- bilder

Ta et merket skjermbilde av en tjener, vis det og slett det som ikke lenger trengs.

Endepunkter 4
Basissti /api/v1/snapshots
BLI /api/v1/snapshots/

List opp alle øyeblikksbilder

Gir skjermbilder på kontoen din, nyeste først, 25 pr. side.

Påkrevd tillatelse: snapshots:list

Eksempelforespørsel

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

Eksempelsvar

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

Svarfelt

Felt Type Beskrivelse
uuid string Skjermbilde- identifikator (32 heksadesimale tegn, ingen bindestreker)
label string Etikett gitt da skjermbildet ble laget
server_hostname string Vertsnavn for tjeneren som skjermbildet ble tatt fra, eller null hvis den tjeneren ikke lenger finnes
ready boolean Sant når skjermbildet er ferdig
deleting boolean Sant mens en sletting pågår
created_at datetime Opprettelsestid (ISO 8601, UTC)
size_gb number Komprimert størrelse i gigabyte
BLI /api/v1/snapshots/{uuid}/

Ta et skjermbilde

Gir et objekt med skjermbilde med feltene over. Bruk det til å spørre deg klar etter at du har laget et skjermbilde.

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

Lag et skjermbilde

Legger et skjermbilde i køen til en tjener og returnerer uuid- en til det nye bildet. Skjermbildet vises med en gang med klart til falskt.

Påkrevd tillatelse: servers:snapshot

Forespørselsparametere

Parameter Type Obligatorisk Beskrivelse
action string Ja Må være et skjermbilde
snapshot_label string Ja En etikett som gjenkjenner skjermbildet 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"])

Eksempelsvar

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

Svarstatuskoder

200 Handlinga ble satt i kø
400 handling eller screenshot_label mangler, eller tjeneren er ikke tatt i bruk ennå
402 Ingen betalingsmetode for fil, eller ubetalte fakturaer
404 Ikke funnet, eller den tilhører en annen konto
SLETT /api/v1/snapshots/{uuid}/

Slett et skjermbilde

Legger skjermbildet i kø for permanent sletting. Sletting er sant til det er borte.

Påkrevd tillatelse: 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 Godtatt: forespørselen ble satt i kø
404 Ikke funnet, eller den tilhører en annen konto

Merknader