VPS.org API

Dọkumenti

API ndabere

Ndesịta nke nchekwa ndị sava gị, malite nchekwa ọfụụ na weghachi sava site n'otu.

Isi njedebe 4
Ụzọ Ntọala /api/v1/backups
Nweta /api/v1/backups/

Depụta ndabere niile

Na-eziga azụta nke sava gị niile, nke ọfụụ n'oge mbụ, 25 n'ihuakwụkwọ. Enweghị sava ọfụụ: jiri server_hostname mee ka ha banye n'ụdị.

Ikikere achọrọ: backups:list

Paịmatị Ajụjụ

Paramita Ụdị A chọrọ Ndesịta ozi ndị ahụ
page integer Ọ bụghị Nọmba ihuakwụkwọ, na-amalite na 1

Arịrịọ Ihe Nlereanya

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);

Ihe Nlereanya Azịza

{
  "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"
    }
  ]
}

Ubi Nzaghachi

_Òkè Ụdị Ndesịta ozi ndị ahụ
id integer Nkọwa banye, ejirila ya site na iwepụ nakwa iwepụ n'ebemkpofuozi
server_hostname string Aha ónyénwē ákàrà ahụ ébubatalálá ná ebé ahụ
name string Aha faịlụ nchekwa
size_gb number Ụhara a gbanyụọ na gigabytes
deletion_date datetime Mgbe a ga-ewepụ báà n'ụzọ mebieghị ụzọ
days_remaining integer Ụbọchị niile dị n'okpuru ruo mgbe ndezi_ụbọchị gachara
created_at datetime Oge mmegharị ahụ (ISO 8601, UTC)

Koodu Ọnọdụ Nzaghachi

200 E weghachiri ndesịta ebe nchekwa ahụ n'ụzọ ziri ezi
403 Ndehie mọọbụ token API adịghị mma, mọọbụ token enweghị ikikembanye achọrọ
Nweta /api/v1/backups/{id}/

Ńgwānụ́ọ̀gụ̀

Na-eziga otu ebe nchekwa ihenhọrọ na mpaghara ebe ndị ahụ n'elu.

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
ANYỊ /api/v1/servers/{uuid}/backup/

Kewapụta ndebata

Na-eburu n'oche ebe nchekwa nke sava a na-edebata. Enweghị mkpanaka ahụ chọrọ. Ebe nchekwa ahụ na-egosi na ndesịta mgbe ọ gasịrị, nke nwere ike ịnabata minit ole na ole dabere na ojiji diski.

Ikikere achọrọ: 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())

Ihe Nlereanya Azịza

{
  "message": "Backup queued successfully"
}

Koodu Ọnọdụ Nzaghachi

200 Nhazi ahụ ébūbúlà
400 Sarùbàtà ahụ agaghị etinyenwu ya n'ọrụ
402 Enweghị ụzọ nkwụ ụgwọ na faịlụ, mọọbụ inweta ndị a na-akwụghị ụgwọ
404 Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ
ANYỊ /api/v1/backups/{id}/restore/

Weghachi sava site na ndebata

Na-akwụsị́ sava ahụ nke ébubatárá ya na ya, na-agụgharị diski ya ná mbinye aka nakwa na-amalite ya ọzọ. Enweghị ihe achọrọ. Ogédị́dị́ ná sava ahụ bụ n'ókè mgbe mmelite na-arụ ọrụ.

Ikikere achọrọ: 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"
}
Ndụmọdụ: Ihe niile e bipụtara na sava mgbe e mechara banye n'ebemkpofuozi ahụ ahapụla. Agaghị enwe ike iwepụ n'ihu n'ebemkpofuozi ahụ.

Koodu Ọnọdụ Nzaghachi

200 Nhazi ahụ ébūbúlà
400 Sarùbàtà ahụ agaghị etinyenwu ya n'ọrụ
404 Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ

Ntụziaka