VPS.org API

Dọkumenti

Foto API

Kwụsị ịpịpụta ngwe nke sava, gosipụta ha na wepụ ndị ahụ ịchọrọ.

Isi njedebe 4
Ụzọ Ntọala /api/v1/snapshots
Nweta /api/v1/snapshots/

Depụta foto niile

Na-eziga n'ihu n'ime akaụntụ gị, nke ọfụụ n'oge mbụ, 25 n'ihuakwụkwọ ọ bụla.

Ikikere achọrọ: snapshots:list

Arịrịọ Ihe Nlereanya

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

Ihe Nlereanya Azịza

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

Ubi Nzaghachi

_Òkè Ụdị Ndesịta ozi ndị ahụ
uuid string Snéèfù ngosi ihe (32 hexadecimal characters, no hyphens)
label string Léèbụ̀ a na-enye mgbe a haziri sịnmbụ̀tà
server_hostname string Aha ónyénwē ákàrà nke sava ahụ ébubatalárà n'ime, mọọbụ null ma ọ bụrụ na sava ahụ abụghị nke ọfụụ
ready boolean Ọ bụ eziokwu mgbe ọbụla mgbe ọbụla n'oge ọbụla
deleting boolean Ọ bụ eziokwu mgbe ehichapụ na-aga n'ihu
created_at datetime Oge mmegharị ahụ (ISO 8601, UTC)
size_gb number Ụhara a gbanyụọ na gigabytes
Nweta /api/v1/snapshots/{uuid}/

Wepụta Sịnmpụ

Na-eziga otu ihenhọrọ sịnmbụsaịtị na mpaghara ebe ndị ahụ n'elu. Jiri ya maka ịkpọọ n'oge mgbe ịkewapụta sịnmbụsaịtị.

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

Kewapụta Snéèptụ̀

Na-ewere n'ogbe sịnmbụsaịtị nke sava a na-edebata ma na-eziga uuid sịnmbụsaịtị ọfụụ. Sịnmbụsaịtị ahụ egosipụtara n'ụzọ n'ụzọ na-emezigharị n'ezighị eziokwu.

Ikikere achọrọ: servers:snapshot

Rịọ maka paramita ahụ

Paramita Ụdị A chọrọ Ndesịta ozi ndị ahụ
action string Ee Ọ ga-abụrịrị ngwe
snapshot_label string Ee Léèbụ̀ ka a mara sịnmpụ̀ site na
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"])

Ihe Nlereanya Azịza

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

Koodu Ọnọdụ Nzaghachi

200 Nhazi ahụ ébūbúlà
400 Nhazi mọọbụ snapshot_label enweghị, mọọbụ sava a na-ewepụghị ya
402 Enweghị ụzọ nkwụ ụgwọ na faịlụ, mọọbụ inweta ndị a na-akwụghị ụgwọ
404 Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ
HICHAPỤ /api/v1/snapshots/{uuid}/

Hichaa S_néèfù

Na-ewere n'ogbe kọmpụta maka ịkpụga n'ozuzu ya. ịkpụga bụ eziokwu ruo mgbe ọ gasịrị.

Ikikere achọrọ: snapshots:delete

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

Koodu Ọnọdụ Nzaghachi

202 Ekwenyere: a hapụrụ arịrịọ ahụ n'ogbe
404 Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ

Ntụziaka