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

პასუხის ველები

ველი ტიპი აღწერა
uuid string სურათის იდენტიფიკატორი (32 hex სიმბოლო, კავშირის გარეშე)
label string ჭდე, რომელიც გამოსახულების შექმნისას მითითდა
server_hostname string სერვერის ჰოსტის სახელი, საიდანაც გადაღებულია სურათი, ან ნულს, თუ სერვერი აღარ არსებობს
ready boolean True როდესაც სურათის გადაღება დასრულდება
deleting boolean მართალი, როდესაც წაშლა მიმდინარეობს
created_at datetime შექმნის დრო (ISO 8601, UTC)
size_gb number შეკუმშული ზომა გიგაბაიტებში
მიიღეთ /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-ის დაბრუნება. სურათი მყისიერად ჩანს სიაში, თუ მზად არის ფალსიფიკაცია.

საჭიროა უფლება: servers:snapshot

მოთხოვნის სხეულის პარამეტრები

პარამეტრები ტიპი სავალდებულო აღწერა
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 ვერ მოიძებნა, ან სხვა ანგარიშს ეკუთვნის

შენიშვნები