VPS.org API

Pagina officialis Documentationis

API Copiarum Subsidiariarum

Servius est in servitudine, et servius est in servitudine, et servius est in servitudine.

Extrema 4
Via Basis /api/v1/backups
ACQUIRE /api/v1/backups/

Enumera Omnes Copias Subsidiarias

Restituit copias securitatis omnes servium, novae primum, 25 pro pagina. Non est filtrum servii: server_ hostname ut grupas.

Permissio necesse: backups:list

Parametri Quaestionis

Parametrus Typus Requisitum Descriptio
page integer No Numerus paginarum, a 1 incipiens

Exemplum Petitionis

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

Exemplum Responsionis

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

Campi Responsorum

Campo Typus Descriptio
id integer Identificator copiae, a punctis finitis obtinus et restitutus
server_hostname string Nomen hostis servitorii ex quo copiae securitatis accepit
name string Nomen archivi backup
size_gb number Magnitudo compressa in gigabytes
deletion_date datetime Cum copia automatice remota sit
days_remaining integer Dies interi restant usque ad deletio_data
created_at datetime Tempore UTC (ISO 8601)

Codices Status Responsorum

200 Index copiarum salvatorum successu recuperatus
403 Token API mancant vel invalidus, aut token permissum necesse non habet
ACQUIRE /api/v1/backups/{id}/

Obtinuit copiam

Restituit unam copiam objecti cum campis supra.

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

Creare copiam

Inquerit servitoris deployans copiam securitatis. Corpus petitionis non est necesse. Copia securitatis in lista apparet cum finitur, quae multas minutas dependens de disci usu ducere potest.

Permissio necesse: 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())

Exemplum Responsionis

{
  "message": "Backup queued successfully"
}

Codices Status Responsorum

200 Actus in columnam inscriptus est
400 Servitor non est iam deployatus
402 Non est methodus pagati in archivio, aut facturae non pagatae
404 Non repertus, aut ad alium contum pertinet
Post /api/v1/backups/{id}/restore/

Restauratio servitorii ex copia garantia

Servitum ab quo copiae securitatis accepit, detenet, discum eius copiae securitatis superscriptum et reinitium. Corpus petitionis non est necesse. Status servitii est in coda cum restitutio in executione.

Permissio necesse: 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"
}
Admonitio: Quod ad servitum scriptum est post copiam securitatis faciendam perditum est. Restauratio non potest annullata.

Codices Status Responsorum

200 Actus in columnam inscriptus est
400 Servitor non est iam deployatus
404 Non repertus, aut ad alium contum pertinet

Notiones