VPS.org API

REST API баримт бичиг

Нөөцлөлт API

Серверийнхээ нөөцлөлтийг жагсааж, шинэ нөөцлөлт эхлүүлж, серверийг нэгнээс нь сэргээнэ.

Төгсгөлийн цэгүүд 4
Суурийн зам /api/v1/backups
АВАХ /api/v1/backups/

Бүх нөөцлөлтийг жагсаах

Бүх серверийнхээ хуулбарыг, хамгийн сүүлийнх нь эхлэн, хуудасны 25-ыг нь буцаана. Серверийн шүүлтүүр байхгүй: серверийн_ хостын нэрийг ашиглан бүлэглэнэ.

Зөвшөөрөл шаардагдана: backups:list

Асуулгын параметрүүд

Параметр Төрөл Шаардлагатай Тодорхойлолт
page integer Үгүй Хуудасны дугаар, 1- ээс эхлэн

Жишээ хүсэлт

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for backup in response.json()["results"]:
    print(backup["id"], backup["server_hostname"], backup["created_at"])
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

Жишээ хариулт

{
  "count": 96,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [
    {
      "id": 5512,
      "server_hostname": "web-01",
      "name": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
      "size_gb": 3.12,
      "deletion_date": "2026-09-21T20:45:40.697512Z",
      "days_remaining": 6,
      "created_at": "2026-09-14T20:45:40.699494Z"
    }
  ]
}

Хариултын талбарууд

Газар Төрөл Тодорхойлолт
id integer Гарах, сэргээх төгсгөлийн цэгүүдийн ашигладаг нөөцлөх илэрхийлэгч
server_hostname string Hostname of the server the backup was taken from
name string Архив файлын нэр
size_gb number Гигабайтаар буулгасан хэмжээ
deletion_date datetime Хэрэв нөөц хуулбарыг автоматаар устгавал
days_remaining integer Бүх өдрүүд үлдсэн
created_at datetime Бүтээх цаг (ISO 8601, UTC)

Хариу үйлдлийн төлөвийн кодууд

200 Засварлах жагсаалт амжилттай авснаа мэдэгдэнэ
403 API-ийн түлхүүр алга, эсвэл хүчингүй, эсвэл түлхүүр нь шаардлагатай эрхийг агуулаагүй
АВАХ /api/v1/backups/{id}/

Нууцлалын хуулбар авах

Дээрх талбаруудтай нэг нөөц объектыг буцаана.

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
ХАЯГДАЛ /api/v1/servers/{uuid}/backup/

Нууцлалын хуулбар үүсгэх

Серверийн нөөцлөлтийг хүлээж байна. Холбоо барих бие байхгүй. нөөцлөлт дууссаны дараа жагсаалтад гарч ирнэ. Дискний ашиглалтаас хамааран хэд хэдэн минут шаардагдана.

Зөвшөөрөл шаардагдана: servers:backup

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/backup/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/backup/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

Жишээ хариулт

{
  "message": "Backup queued successfully"
}

Хариу үйлдлийн төлөвийн кодууд

200 Ажиллал хүлээгдэж байна
400 Сервер одоогоор суулгагдаагүй байна
402 Хуудаст төлбөрийн арга байхгүй, эсвэл төлбөрөө төлөөгүй
404 Олдоогүй эсвэл өөр дансанд хамаарна
ХАЯГДАЛ /api/v1/backups/{id}/restore/

Серверийг хадгалах данснаас сэргээх

Засварлах серверийг зогсоож, хадгалах дискийг нь засах ба дахин эхлүүлнэ. Холбоо барих заавар хэрэггүй. Суулгах үйлдэл явагдаж байх үед серверийн байдал нь хүлээлтэд байна.

Зөвшөөрөл шаардагдана: backups:restore

curl -X POST "https://admin.vps.org/api/v1/backups/5512/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Backup restore queued. The server will be stopped, restored, and restarted.",
  "backup": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}
Сэтгэл зүй: Бүх сервер дээрх хадгалах нөөцийг устгасан тохиолдолд бүх бичлэгүүд алга болно. Буцаах үйлдлийг буцааж чадахгүй.

Хариу үйлдлийн төлөвийн кодууд

200 Ажиллал хүлээгдэж байна
400 Сервер одоогоор суулгагдаагүй байна
404 Олдоогүй эсвэл өөр дансанд хамаарна

Сэтгэгдэл