VPS.org API

REST API Documentation

API yeSnapshots

Take inozivikanwa snapshots ye server, kuisa kwavo uye kubvisa avo iwe hauna kufanira.

Magumo 4
Nzira Yekutanga /api/v1/snapshots
Tora /api/v1/snapshots/

Rondedzera Mifananidzo Yese

Retourne les snapshots dans votre compte, le plus récent d'abord, 25 par page.

Kuda mvumo: snapshots:list

Muenzaniso weChikumbiro

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

Muenzaniso weMhinduro

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

Minda Yemhinduro

_Firi Rudzi Kutaura
uuid string Snapshot identifier (32 hexadecimal characters, no hyphens)
label string Label yapihwa apo snapshot yakagadzirwa
server_hostname string Izwi remushandisi weserver iyo snapshot yakatora kubva, kana null kana iyo server yatanga kuwanikwa
ready boolean True kana snapshot yapera
deleting boolean True kana kubvisa kuri kuitwa
created_at datetime Kuumbwa kwenguva (ISO 8601, UTC)
size_gb number Yakakomberedza upamhi mu gigabytes
Tora /api/v1/snapshots/{uuid}/

Kuwana Snapshot

Inodzosera imwe snapshot chinhu nenzvimbo dzepasi. Dzokera ku poll yagadzirira mushure mekugadzira snapshot.

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

Kugadzira Snapshot

Inoisa muhomwe snapshot yemushandisi akaiswa muhomwe uye inodzosera uuid yemushandisi. Snapshot inoratidzwa pakutanga ne ready yakaiswa pa false.

Kuda mvumo: servers:snapshot

Kumbira Maparamita Emuviri

Parameter Rudzi Zvinodiwa Kutaura
action string Ehe Inofanira kunge iri snapshot
snapshot_label string Ehe A label to recognize the snapshot by
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"])

Muenzaniso weMhinduro

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

Makodhi eMamiriro eMhinduro

200 Chiito ichi chakanga chaiswa mubhokisi
400 action kana snapshot_label haasipo, kanawo sevashambadziri havana kuiswa panzvimbo
402 Hapana nzira yekubhadhara yakanyorwa, kana invoices dzisina kubhadharwa
404 Haichawanikwa, kana kuti inobva kune imwe account
DZIMA /api/v1/snapshots/{uuid}/

Delete a Snapshot

Kuisa snapshot mubhokisi rezvinyorwa kuti rigadziriswe. Kubvisa kuri nyore kusvika richidzokera kunzvimbo yacho.

Kuda mvumo: snapshots:delete

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

Makodhi eMamiriro eMhinduro

202 Accepted: the request was queued
404 Haichawanikwa, kana kuti inobva kune imwe account

Nhoroondo