VPS.org API

REST API dokumentasyon

Mga Backup API

Ilista ang iyong server backup, simulan ang isang bagong backup at ibalik ang isang server mula sa isa.

Mga Endpoint 4
Landas ng Batayan /api/v1/backups
KUMUHA /api/v1/backups/

Ilista ang Lahat ng Backup

Bumalik ang mga backup ng lahat ng iyong mga server, pinakabagong unang, 25 bawat pahina. Walang server filter: gamitin server_hostname upang grupo ang mga ito.

Kailangang pahintulot: backups:list

Mga Parameter ng Query

Parameter Uri Kinakailangan Paglalarawan
page integer Hindi Page number, nagsisimula sa 1

Halimbawang Kahilingan

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

Halimbawang Tugon

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

Mga Patlang ng Tugon

Patlang Uri Paglalarawan
id integer Backup identifier, ginagamit ng makakuha at ibalik ang endpoints
server_hostname string Hostname ng server ang backup ay kinuha mula sa
name string Backup archive file pangalan
size_gb number Compressed laki sa gigabytes
deletion_date datetime Kapag ang backup ay aalisin nang awtomatikong
days_remaining integer Buong araw na kaliwa hanggang sa deletion_date
created_at datetime Oras ng paglikha (ISO 8601, UTC)

Mga Kodigo ng Katayuan ng Tugon

200 Matagumpay na nakuha backup listahan
403 Walang o hindi wastong API token, o ang token ay kulang ang kinakailangang pahintulot
KUMUHA /api/v1/backups/{id}/

Kumuha ng isang Backup

Bumalik ng isang backup na bagay sa mga patlang sa itaas.

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

Lumikha ng isang backup

Queues isang backup ng isang deployed server. Walang katawan ng kahilingan ay kinakailangan. Ang backup ay lilitaw sa listahan kapag ito ay tapos na, na maaaring tumagal ng ilang minuto depende sa disk paggamit.

Kailangang pahintulot: 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())

Halimbawang Tugon

{
  "message": "Backup queued successfully"
}

Mga Kodigo ng Katayuan ng Tugon

200 Ang aksyon ay naka-queue
400 Ang server ay hindi deployed pa
402 Walang paraan ng pagbabayad sa file, o hindi nababayaran invoice
404 Hindi natagpuan, o ito ay pag-aari ng iba pang account
Post /api/v1/backups/{id}/restore/

Ibalik ang isang Server mula sa isang Backup

Stops ang server ang backup ay kinuha mula sa, overwrites disk nito sa backup at nagsisimula ito muli. Walang katawan ng kahilingan ay kinakailangan. Ang server status ay queue habang ang ibalik ang tumatakbo.

Kailangang pahintulot: 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"
}
Babala: Lahat ng nakasulat sa server pagkatapos ng backup ay kinuha ay nawala. Ang isang ibalik ay hindi maaaring undone.

Mga Kodigo ng Katayuan ng Tugon

200 Ang aksyon ay naka-queue
400 Ang server ay hindi deployed pa
404 Hindi natagpuan, o ito ay pag-aari ng iba pang account

Mga tala