VPS.org API

Dokumentazzjoni tal-REST API

API tal-Snapshots

Ħu snapshots immarkati ta ’server, elenkahom u tħassar dawk li m'għadx għandek bżonn.

Punti tat-tmiem 4
Mogħdija Bażika /api/v1/snapshots
IKSEB /api/v1/snapshots/

Elenka r-Ritratti Kollha

Jirritorna l-istantanea fil-kont tiegħek, l-ewwel l-aktar ġdid, 25 kull paġna.

Permess meħtieġ: snapshots:list

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

Oqsma ta' Rispons

Qasam Tip Deskrizzjoni
uuid string Identifikatur tal-istampa (32 karattru eżadeċimali, mingħajr ħjut)
label string Tikketta mogħtija meta nħoloq l-istampa
server_hostname string Isem tal-host tas-server li minnu ttieħed l-istampa, jew null jekk dak is-server ma għadux jeżisti
ready boolean Veru ladarba l- snapshot ikun lest
deleting boolean Veru waqt li t-tħassir ikun għaddej
created_at datetime Ħin tal-ħolqien (ISO 8601, UTC)
size_gb number Daqs ikkompressat f'gigabytes
IKSEB /api/v1/snapshots/{uuid}/

Ikseb Snapshot

Jirritorna oġġett snapshot wieħed mal-oqsma hawn fuq. Użah biex poll lest wara li toħloq snapshot.

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

Oħloq Snapshot

Jikkwota snapshot ta' server imħaddem u jirritorna l-uuid tal-istantanju l-ġdid. L-istantanju huwa elenkat minnufih b'lest stabbilit għal falz.

Permess meħtieġ: servers:snapshot

Parametri tal-Korp tat-Talba

Parametru Tip Meħtieġ Deskrizzjoni
action string Iva Għandu jkun snapshot
snapshot_label string Iva Tikketta biex tirrikonoxxi l-istampa instantanja permezz ta’
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"])

Eżempju ta' Rispons

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

Kodiċijiet tal-Istatus tar-Rispons

200 L-azzjoni kienet fil-kju
400 action jew snapshot_label nieqsa, jew is-server għadu ma ġiex imħaddem
402 Ebda metodu ta' ħlas fil-fajl, jew fatturi mhux imħallsa
404 Ma nstabx, jew jappartjeni għal kont ieħor
ĦASSAR /api/v1/snapshots/{uuid}/

Ħassar Snapshot

Queues l-istantanea għat-tħassir permanenti. tħassir huwa veru sakemm huwa marret.

Permess meħtieġ: snapshots:delete

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

Kodiċijiet tal-Istatus tar-Rispons

202 Aċċettat: it-talba ġiet imqiegħda fil-kju
404 Ma nstabx, jew jappartjeni għal kont ieħor

Noti