VPS.org API

Documentare API REST

API-ul Snapshot-urilor

Luaţi instantanii etichetate ale unui server, listează-le şi ştergeţi cele care nu mai aveţi nevoie.

Puncte finale 4
Calea de bază /api/v1/snapshots
OBŢINE /api/v1/snapshots/

Listați toate instantaneele

Reduce imaginea din contul dvs., noul, 25 pe pagina.

Permisul necesar: snapshots:list

Exemplu de solicitare

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

Exemplu de răspuns

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

Câmpuri de răspuns

Câmp Tip Descriere
uuid string Identificator de snapshot (32 caractere hexadecimiale, fără feluri)
label string Eticheta dată când instantania a fost creată
server_hostname string Numele de nume al serverului a fost luată din imaginea sau nul dacă acest server nu mai există
ready boolean Adevărat odată ce s-a terminat imaginea
deleting boolean Adevărat în timp ce o ştergere este în curs de desfacere
created_at datetime Ora de creare (ISO 8601, UTC)
size_gb number Dimensiune comprimată în gigabytes
OBŢINE /api/v1/snapshots/{uuid}/

Ia o snapseu

Returnează un obiect de snapshot cu câmpurile de mai sus. Folosește-l pentru sondaje gata după crearea unui snapshot.

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

Creează o captura de pantalla

Încuie o imagine a unui server implementat și returnează uuid noul instantaneu. Instantanea este listată imediat cu set gata la fals.

Permisul necesar: servers:snapshot

Parametrii corpului cererii

Parametrul Tip Necesar Descriere
action string Da Trebuie să fie o imagine
snapshot_label string Da Eticheta pentru a recunoaște imaginea de
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"])

Exemplu de răspuns

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

Coduri de stare a răspunsului

200 Acţiunea a fost în coada
400 acțiune sau snapshot_etichetă lipsește, sau serverul nu este încă desfășurat
402 Nu există metodă de plată pe dosar sau facturi nereturnate
404 Nu a fost găsit, sau aparţine unui alt cont
ŞTERGE /api/v1/snapshots/{uuid}/

Șterge o captura de pantalla

Coada instantaneu pentru ștergere permanentă. eliminarea este adevărat până când nu este.

Permisul necesar: snapshots:delete

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

Coduri de stare a răspunsului

202 Acceptată: cererea a fost în coada
404 Nu a fost găsit, sau aparţine unui alt cont

Note