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 аломати даҳӣ, бе аломати ҷудокунанда)
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-и тасвири лаҳзаи навро бармегардонад. Тасвири лаҳзаи нав бо ready ба 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 Ё ки ёфт нашуд ё ба ҳисоби дигар тааллуқ дорад

Ёддоштҳо