VPS.org API

REST API dokumentācija

Momentuzņēmumu API

Veikt iezīmētus servera momentuzņēmumus, tos sarakstus un dzēst tos, kas jums vairs nav nepieciešami.

Galapunkti 4
Bāzes ceļš /api/v1/snapshots
IEGŪT /api/v1/snapshots/

Uzskaitīt visus momentuzņēmumus

Atgriež fotogrāfijas savā kontā, jaunākā pirmā, 25 par lapu.

Nepieciešamā atļauja: snapshots:list

Pieprasījuma piemērs

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

Atbildes piemērs

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

Atbildes lauki

Lauks Tips Apraksts
uuid string Snapshot identifikators (32 hidroletes zīmes, nav hifenu)
label string Etiķete, kad tika radīts momentuzraksts
server_hostname string Servera datora nosaukums, no kura tika izņemts momentuzraksts, vai nu nulle, ja šis serveris vairs nepastāv
ready boolean Patiess, kad momentuzņēmums ir pabeigts
deleting boolean Patiess, kamēr notiek dzēšana
created_at datetime Izveides laiks (ISO 8601, UTC)
size_gb number Saspiests izmērs gigabaitos
IEGŪT /api/v1/snapshots/{uuid}/

Saķeriet

Atgriež vienu momentuzņēmumu ar laukiem, kas ir augstāk. Izmantojiet to, lai pēc momentuzņēmuma izveidošanas aptaujātu gatavs.

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

Izveidot momentuzņēmumu

Ielādē ierīkotā servera momentuzņēmumu un atgriež jaunā momentuzņēmuma uuid. Tas tiek parādīts uzreiz ar gatavu iestatītu nepatiesu.

Nepieciešamā atļauja: servers:snapshot

Pieprasījuma pamatteksta parametri

Parametrs Tips Obligāti Apraksts
action string Jā Jābūt momentuzņēmumam
snapshot_label string Jā Etiķete, lai atpazītu momentuzņēmumu pēc
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"])

Atbildes piemērs

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

Atbildes statusa kodi

200 Prasība tika ierindota rindā
400 darbība vai momentogrāfija_etiķete trūkst, vai serveris vēl nav izvietots
402 Nav maksājuma metodes lietā, vai neapmaksāti rēķini
404 Nav atrasts, vai arī tas pieder citam kontam
DZĒST /api/v1/snapshots/{uuid}/

Dzēst momentuzņēmumu

Ierindo momentuzņēmumu, lai veiktu pastāvīgu dzēšanu. Dzēšanu veic, līdz tā ir pazudusi.

Nepieciešamā atļauja: snapshots:delete

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

Atbildes statusa kodi

202 Pieņemts: pieprasījums tika rindā
404 Nav atrasts, vai arī tas pieder citam kontam

Piezīmes