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 Snapshot identifier (32 hexadecimal characters, no hyphens)
label string Зураг авах үед өгсөн тэмдэгт
server_hostname string Зураг авах серверийн нэр, эсвэл сервер байхгүй бол нууц үг
ready boolean Зураг авах ажиллагаа дууссаны дараа үнэн
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 Олдоогүй эсвэл өөр дансанд хамаарна

Сэтгэгдэл