VPS.org API

REST API Documentation

Zithunzi Zazing'ono API

Take labelled snapshots ya seva, mnda wawo ndi kuchotsa amene inu simungafune.

Mapeto 4
Njira Yoyambira /api/v1/snapshots
Pezani /api/v1/snapshots/

Lembani Zithunzi Zonse

Kubwerera snapshots mu akaunti yanu, zatsopano koyamba, 25 patsamba.

Kufunikira kwa ufulu: snapshots:list

Chitsanzo cha Pempho

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

Chitsanzo cha Yankho

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

Mayankho a Minda

Kuwala Mtundu Kufotokozera
uuid string Mtundu wa chithunzi (mawu 32 hexadecimal, palibe ma hyphens)
label string Label yoperekedwa pamene chithunzicho chimapangidwa
server_hostname string dzina la m'nyumba la seva yomwe chithunzicho chidachokera, kapena null ngati serveryo siyikupezeka
ready boolean Chowona pamene chithunzicho chatha
deleting boolean Chowona pamene kuchotsa kulipo
created_at datetime Nthawi yopangidwa (ISO 8601, UTC)
size_gb number Kukula kwa kuyimitsidwa m'gigabytes
Pezani /api/v1/snapshots/{uuid}/

Pezani chithunzithunzi

Imabweretsa chithunzithunzi cha chinthu chimodzi ndi malo a pamwambapa. Ikani kuti mufufuze ngati mwatha kupanga chithunzithunzi.

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

Kukhazikitsa Snapshot

Imapanga mzere wa snapshot ya seva yosinthidwa ndipo imabwerera uuid ya snapshot yatsopano. Snapshot imapezeka mofulumira ndi ready yosinthidwa kukhala false.

Kufunikira kwa ufulu: servers:snapshot

Pemphani Ma Parameter a Thupi

Paramita Mtundu Zofunika Kufotokozera
action string Inde Iyenera kukhala snapshot
snapshot_label string Inde Kulemba kuti mudziwe chithunzicho
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"])

Chitsanzo cha Yankho

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

Makhodi a Mkhalidwe Woyankha

200 Chikhalidwechi chinali chosagwirizana
400 action kapena snapshot_label sichipezeka, kapena seva siyimakonzedwabe
402 Simunasankhe njira yolipira kapena simunalandire ndalama
404 Siyipezeka, kapena ili ndi akaunti ina
CHOTSANI /api/v1/snapshots/{uuid}/

Ku_chotsa chithunzi

Amaika chithunzicho m'gulu kuti chitulutsidwe mwamsanga. kuchotsa ndi koyenera mpaka chidzachotsedwa.

Kufunikira kwa ufulu: snapshots:delete

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

Makhodi a Mkhalidwe Woyankha

202 Yavomerezedwa: lamuloli linali m'gulu
404 Siyipezeka, kapena ili ndi akaunti ina

Zikumbutso