VPS.org 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'ин кайтарат. Снимки отображаются сразу же, если готово установлено на false.

Укуктар керек: 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 action же snapshot_label жок, же сервер азырынча орнотулбаган
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 Табылган жок же башка эсептик жазууга таандык

Заметки