VPS.org API

REST API skjölun

Afritunarforritaskil

Listi yfir öryggisafrit af netþjónum þínum, hefja nýja öryggisafrit og endurheimta netþjón frá einum.

Endapunktar 4
Grunnslóð /api/v1/backups
FÁ /api/v1/backups/

Listi yfir öll afrit

Sýnir afrit af öllum þjónum þínum, nýjustu fyrst, 25 á síðu. Það er engin þjónasía: notaðu server_ hostname til að flokka þau.

Nauðsynlegt leyfi: backups:list

Fyrirspurnarbreytur

Breyta Tegund Nauðsynlegt Lýsing
page integer Nei Síðunúmer, byrjar á 1

Dæmi um beiðni

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

Dæmi um svar

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

Svarsvið

Field Tegund Lýsing
id integer Auðkenni öryggisafrits, notað af endapunktum sækja og endurheimta
server_hostname string Vélarheiti miðlarans sem afrit var tekið frá
name string Nafn öryggisafns
size_gb number Þjappað stærð í gígabætum
deletion_date datetime Þegar öryggisafrit verður fjarlægt sjálfkrafa
days_remaining integer Heilir dagar eftir til eyðingar_ dags
created_at datetime Sköpunartími (ISO 8601, UTC)

Kóðar fyrir svörunarstöðu

200 Sækja öryggisafrit
403 Vantar eða ógilt API tákn, eða táknið hefur ekki nauðsynleg leyfi
FÁ /api/v1/backups/{id}/

Fáðu öryggisafrit

Sýnir eina öryggisafrit hlut með reitunum hér að ofan.

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

Búa til afrit

Býður upp á afrit af þjóni sem er í notkun. Engin beiðni þarf að vera til staðar. Afritunin birtist í listanum þegar henni er lokið, sem getur tekið nokkrar mínútur eftir notkun diska.

Nauðsynlegt leyfi: 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())

Dæmi um svar

{
  "message": "Backup queued successfully"
}

Kóðar fyrir svörunarstöðu

200 Aðgerðin var sett í biðröð
400 Þjónninn er ekki ennþá í notkun
402 Engin greiðsluaðferð í skránni eða ógreiddar reikningar
404 Fannst ekki, eða það tilheyrir öðrum reikningi
POST /api/v1/backups/{id}/restore/

Endurheimta miðlara úr öryggisafrit

Stöðvar þjóninn sem afrit var tekið af, skrifar yfir diskinn með afritinu og ræsir hann aftur. Engin beiðni er þörf. Staða þjónsins er biðröð meðan endurheimtin er í gangi.

Nauðsynlegt leyfi: 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"
}
Viðvörun: Allt sem skrifað var á þjóninn eftir að afrit var tekið glatast. Ekki er hægt að afturkalla endurheimt.

Kóðar fyrir svörunarstöðu

200 Aðgerðin var sett í biðröð
400 Þjónninn er ekki ennþá í notkun
404 Fannst ekki, eða það tilheyrir öðrum reikningi

Athugasemdir