VPS.org API

REST API-dokumentation

API för ögonblicksbilderName

Ta märkta ögonblicksbilder av en server, lista dem och ta bort de du inte längre behöver.

Slutpunkter 4
Basväg /api/v1/snapshots
FÅ /api/v1/snapshots/

Lista alla ögonblicksbilder

Returnerar ögonblicksbilder på ditt konto, nyaste först, 25 per sida.

Krav på tillstånd: snapshots:list

Exempelförfrågan

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

Exempelsvar

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

Svarsfält

Fält Typ Varuslag
uuid string Snapshot-identifierare (32 hexadecimala tecken, inga bindestreck)
label string Etikett angiven när ögonblicksbilden skapades
server_hostname string Värddatornamn på servern som ögonblicksbilden togs från, eller noll om servern inte längre finns
ready boolean Sant när ögonblicksbilden är klar
deleting boolean Det är sant att en radering pågår
created_at datetime Tid för skapande (ISO 8601, UTC)
size_gb number Komprimerad storlek i gigabyte
FÅ /api/v1/snapshots/{uuid}/

Få en ögonblicksbild

Returnerar ett ögonblicksbildobjekt med fälten ovan. Använd det för att välja klar efter att ha skapat en ögonblicksbild.

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Från och med den 1 januari 2016 till och med den 31 december 2016 /api/v1/servers/{uuid}/snapshot/

Skapa ett ögonblicksbild

Köar en ögonblicksbild av en utplacerad server och returnerar den nya ögonblicksbildens uuid. Ögonblicksbilden listas direkt med klar inställd till falsk.

Krav på tillstånd: servers:snapshot

Parametrar för begäran

Parameter Typ Nödvändig Varuslag
action string Ja Måste vara ögonblicksbild
snapshot_label string Ja En etikett för att känna igen ögonblicksbilden genom att
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"])

Exempelsvar

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

Svarsstatuskoder

200 Åtgärden var köad
400 åtgärd eller snapshot_ label saknas, eller servern är inte utplacerad ännu
402 Ingen betalningsmetod på fil eller obetald räkning
404 Inte hittat, eller det tillhör ett annat konto
RADERA /api/v1/snapshots/{uuid}/

Ta bort ett ögonblicksbild

Köar ögonblicksbilden för permanent borttagning. Radering är sant tills den är borta.

Krav på tillstånd: snapshots:delete

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

Svarsstatuskoder

202 Godkänt: begäran var köad
404 Inte hittat, eller det tillhör ett annat konto

Anmärkningar