VPS.org API

REST API दस्तऐवजीकरण

स्नॅपशॉट्स API

सर्वरचे लेबल केलेले स्नैपशॉट घ्या, त्यांची यादी करा व तुम्हाला आता हवी नसलेली कागदपत्रे काढून टाका.

शेवटचे बिंदू 4
बेस पाथ /api/v1/snapshots
मिळवा /api/v1/snapshots/

सर्व स्नॅपशॉट्सची यादी करा

तुमच्या खात्यामधील स्नैपशॉट परत करतो, नविन प्रथम, 25 प्रति पान.

आवश्यक परवानगी: snapshots:list

उदाहरण विनंती

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

उदाहरण प्रतिसाद

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

प्रतिसाद फील्ड

क्षेत्र प्रकार वर्णन@ title: window
uuid string स्नैपशॉट ओळखकर्ता (32 hex अक्षर, हाइफन्स नाही)
label string स्नैपशॉट बनविण्यावेळी दिलेले लेबल
server_hostname string सर्व्हरचे यजमाननाव जेथे स्नैपशॉट घेतला गेला, किंवा जर ते सर्व्हर आता अस्तित्वात नसेल तर नूतनीकृत करा
ready boolean स्नैपशॉट पूर्ण झाल्यानंतर खरे
deleting boolean काढूण टाकण्याकरीता प्रक्रियेदरम्यान खरे
created_at datetime बनविण्याचे वेळ (ISO 8601, UTC)
size_gb number gigabytes अंतर्गत संकुचित आकार
मिळवा /api/v1/snapshots/{uuid}/

स्नैपशॉट घ्या

वरील क्षेत्र सह एक स्नैपशॉट घटक परत करतो. स्नैपशॉट बनविल्यानंतर पोल् तयार करण्याकरीता त्याचा वापर करा.

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

स्नैपशॉट बनवा

सर्वरचे स्नैपशॉट कतारबद्ध करते व नविन स्नैपशॉटचे uuid परत करते. स्नैपशॉट तयार असल्यावर लगेचच सूचीबद्ध केले जाते false करीता निश्चित केले आहे.

आवश्यक परवानगी: servers:snapshot

बॉडी पॅरामीटर्सची विनंती करा

परिमाण प्रकार आवश्यक वर्णन@ title: window
action string होय स्नैपशॉट असायला हवे
snapshot_label string होय स्नैपशॉट ओळखण्याकरीता लेबल
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"])

उदाहरण प्रतिसाद

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

प्रतिसाद स्थिती कोड

200 क्रिया कतारबद्ध केली गेली
400 क्रिया किंवा स्नैपशॉट_ लेबल आढळले नाही, किंवा सर्वर अजूनही कार्यान्वित झालेले नाही
402 फाइलवर कोणत्याही प्रकारचे पेमेंट नाही, किंवा भरलेले नसलेले बिल
404 आढळले नाही किंवा ते इतर खात्याशी संबंधित आहे
हटवा /api/v1/snapshots/{uuid}/

स्नैपशॉट नष्ट करा

स्थायीरित्या काढून टाकण्याकरीता स्नैपशॉटची कतार करते. काढून टाकणे ते नष्ट होईपर्यंत सत्य आहे.

आवश्यक परवानगी: snapshots:delete

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

प्रतिसाद स्थिती कोड

202 स्वीकारले: विनंती कतारबद्ध केली गेली
404 आढळले नाही किंवा ते इतर खात्याशी संबंधित आहे

टिपण्णी