VPS.org API

REST API Documentation

API Yosungira Zinthu Zosungidwa

Limbikitsani zosunga zobwezeretsera za seva yanu, yambitsani kubwezeretsa kwatsopano ndi kubwezeretsa seva kuchokera ku imodzi.

Mapeto 4
Njira Yoyambira /api/v1/backups
Pezani /api/v1/backups/

Lembani Zosungira Zonse

Kubwerera kamodzi ya onse anu servers, zatsopano koyamba, 25 patsamba. Palibe server wochotsa: kugwiritsa ntchito server_hostname kuti asonkhanitse iwo.

Kufunikira kwa ufulu: backups:list

Ma Parameter a Mafunso

Paramita Mtundu Zofunika Kufotokozera
page integer Si Nambala ya tsamba, imayamba pa 1

Chitsanzo cha Pempho

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

Chitsanzo cha Yankho

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

Mayankho a Minda

Kuwala Mtundu Kufotokozera
id integer Kusunga zosunga wodziwika, amagwiritsa ntchito kulandira ndi kubwezeretsa endpoints
server_hostname string dzina la mkonzi wa server yomwe inali yobwezeretsedwa
name string Kusunga zobwezeretsera archive
size_gb number Kukula kwa kuyimitsidwa m'gigabytes
deletion_date datetime Pamene backups adzathetsedwa mwamsanga
days_remaining integer Masiku onse otsala mpaka deletion_date
created_at datetime Nthawi yopangidwa (ISO 8601, UTC)

Makhodi a Mkhalidwe Woyankha

200 Kusangalala ndi backups
403 Kukayika kapena ayi API token, kapena token alibe zofunika chilolezo
Pezani /api/v1/backups/{id}/

Kupeza Backup

Kubwerera kamodzi imodzi backups chinthu ndi nyanja pamwambapa.

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

Kulenga Backup

Amapanga mzere wa backup ya server yosinthidwa. Sichifunikira thupi la funso. Backup imawonekera mumnda pamene yamaliza, zomwe zingatenge mphindi zingapo malinga ndi kugwiritsa ntchito diski.

Kufunikira kwa ufulu: 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())

Chitsanzo cha Yankho

{
  "message": "Backup queued successfully"
}

Makhodi a Mkhalidwe Woyankha

200 Chikhalidwechi chinali chosagwirizana
400 Mtumiki sikuti wakonzedwa
402 Simunasankhe njira yolipira kapena simunalandire ndalama
404 Siyipezeka, kapena ili ndi akaunti ina
POST /api/v1/backups/{id}/restore/

Kubwezeretsa Server kuchokera ku Backup

Imanyamula server yomwe backup idachokera, imalemba pa diski yake ndi backup ndipo imayambanso. Simungafune thupi la mafunso. Mtundu wa server ndi wokhala mu mnda wazoyembekezereka pamene kubwezeretsa kumayenda.

Kufunikira kwa ufulu: 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"
}
Kuwunika: Zonse zimene zalemba pa seva pambuyo pa kubwezeretsa zidzatha. Kubwezeretsa sikungathe kulephera.

Makhodi a Mkhalidwe Woyankha

200 Chikhalidwechi chinali chosagwirizana
400 Mtumiki sikuti wakonzedwa
404 Siyipezeka, kapena ili ndi akaunti ina

Zikumbutso