VPS.org API

Ҳуҷҷатгузории REST API

API-и нусхабардорӣ

Рӯйхати захираҳои сервери шумо, оғози захираи нав ва барқароркунии сервер аз яке.

Нуқтаҳои ниҳоӣ 4
Роҳи асосӣ /api/v1/backups
ГИРЕД /api/v1/backups/

Рӯйхати ҳамаи нусхаҳои эҳтиётӣ

Бозгардонидани нусхаи эҳтиётии ҳамаи серверҳои шумо, аввал навтарин, 25 дар як саҳифа. Филтри сервер вуҷуд надорад: барои гурӯҳбандӣ истифода баред server_ hostname.

Иҷозат лозим аст: 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 Номи соҳиб барои сервере, ки нусхаи эҳтиётӣ аз он гирифта шудааст
name string Номи файли бойгонии захираи нусхаи эҳтиётӣ
size_gb number Андозаи фишурдашуда дар гигабайтҳо
deletion_date datetime Вақти худкор тоза кардани нусхаи эҳтиётӣ
days_remaining integer Рӯзҳои пурра то рӯзи нобудкунӣ боқӣ мондаанд
created_at datetime Вақти эҷод (ISO 8601, UTC)

Рамзҳои ҳолати посух

200 Рӯйхати захираи нусхаи эҳтиётӣ бо муваффақият барқарор карда шуд
403 API-и нодуруст ё гумшуда ё иҷозатномаи лозимӣ барои token нест
ГИРЕД /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 Ё ки ёфт нашуд ё ба ҳисоби дигар тааллуқ дорад

Ёддоштҳо