VPS.org API

Constellation name (optional)

Rugsteun-API

Lys van die bediener rugsteun, begin 'n nuwe rugsteun en herstel' n bediener van een.

Eindpunte 4
Basispad /api/v1/backups
KRY /api/v1/backups/

Lys alle rugsteun

Gee terug die rugsteun van alle jou bedieners, nuutste eerste, 25 per bladsy. Daar is geen bediener filter: gebruik bediener_hostnaam om hulle te groepeer nie.

Benodigde toestemming: backups:list

Navraagparameters

Parameter Tipe Vereis Beskrywing
page integer Nee Bladsy nommer, beginne na 1

Voorbeeldversoek

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

Voorbeeldantwoord

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

Antwoordvelde

Veld Tipe Beskrywing
id integer Rugsteunidentifiseerder, gebruik deur die ontvang en herstel puntpunte
server_hostname string Gasheernaam van die bediener van die rugsteun is geneem van
name string Rugsteun argief lêernaam
size_gb number Saamgepersde grootte in gigante
deletion_date datetime Wanneer die rugsteun sal wees verwyder automaties
days_remaining integer Hele dae oor totdat skrap_datum
created_at datetime Skeppingstyd (Iso 8601, UTC)

Reaksiestatuskodes

200 Suksesvol herwinde rugsteun lys
403 Ontbrekende of ongeldige API-bewys, of die teken het nie die nodige toestemming nie
KRY /api/v1/backups/{id}/

Kry 'n rugsteun

Gee terug een rugsteun voorwerp met die velde hierbo.

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

Skep 'n rugsteun

Wagtou 'n rugsteun van' n geneede bediener. Nee versoek liggaam is benodig. Die rugsteun verskyn in die lys as dit het klaar, wat kan neem etlike minute afhangende van disket gebruik.

Benodigde toestemming: 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())

Voorbeeldantwoord

{
  "message": "Backup queued successfully"
}

Reaksiestatuskodes

200 Die aksie is getou
400 Die bediener is nog nie geà ̄nuis nie
402 Geen betalingsmetode op lêer, of onbetaalde fakture,
404 Nie gevind nie, of dit behoort aan 'n ander rekening
AGT /api/v1/backups/{id}/restore/

Herstel 'n bediener van' n rugsteun

Stop die bediener van die rugsteun was geneem, oorskryf sy disket met die rugsteun en beginne dit weer. Nee versoek liggaam is benodig. Die bediener status is wag terwyl die herstel hardloop.

Benodigde toestemming: 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"
}
Waarskuwing: Alles wat na die bediener geskryf is nadat die rugsteun geneem is, is verlore. 'n Herstel kan nie ongedaan gemaak word nie.

Reaksiestatuskodes

200 Die aksie is getou
400 Die bediener is nog nie geà ̄nuis nie
404 Nie gevind nie, of dit behoort aan 'n ander rekening

Notas