VPS.org API

@ action

API na Ajiyayyen Bayanai

Ka lissafa rikodin maɓallin mai ba da sabis, fara rikodin sabon kuma mai dawo da mai ba da sabis daga ɗaya.

Ƙarshen maki 4
Hanyar Tushe /api/v1/backups
SAMU /api/v1/backups/

Jera Duk Ajiyar Bayanai

Returns the backups of all your servers, newest first, 25 per page. There is no server filter: use server_hostname to group them.

Required permission: backups:list

Sigogin Tambaya

Parameters Nau'i Ana buƙata @ action
page integer QDialogButtonBox Page number, starting at 1

Buƙatar Misali

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

Misalin Amsar

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

Wuraren Amsawa

@ action Nau'i @ action
id integer Mai ganewa na tabbatacciyar fayil, ana amfani da shi ta hanyar samun da sake dawo da maɓallin ƙarshe
server_hostname string Sunan mai masaukin mai watsawa da aka karɓi rikodin daga
name string Sunan fayil na arhifin tabbatacciya
size_gb number Girman da aka rufe cikin gigabaituna
deletion_date datetime Lokacin da za'a cire tabbataccen fayil ɗin da aka adana cikin tsari
days_remaining integer day of week
created_at datetime Lokacin ƙirƙira (ISO 8601, UTC)

Lambobin Matsayin Amsawa

200 An samu jerin tabbatacciyar fayil da kyau
403 An rasa ko kuma an karya tabbacin API, ko kuma tabbacin bai da izinin da ake bukata
SAMU /api/v1/backups/{id}/

Get a Backup

Returns one backup object with the fields above.

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

Create a Backup

Ana yin rijista na rikodin ma'aikaci da aka shigar. Babu bukatar jikin tambaya. Rikodin rikodin zai bayyana a cikin jerin idan ya kammala, wanda zai iya ɗaukar mintina da yawa dangane da amfani da diski.

Required permission: 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())

Misalin Amsar

{
  "message": "Backup queued successfully"
}

Lambobin Matsayin Amsawa

200 An sanya aikin cikin jerin gwano
400 An kasa shigar da mai ba da sabis
402 Babu hanyar biyan kuɗi a cikin fayil, ko kuma ba'a biya ba
404 An kasa gano shi, ko kuma yana da alaƙa da wani asusu na daban
QSql /api/v1/backups/{id}/restore/

Mai da Mai Gudana daga Ajiyayyen

Ana hana mai masaukin da aka yi rikodin daga, ana sake rubuta diski da rikodin kuma ana fara shi daga farko. Ba a buƙatar wani jikin tambaya. Halitar mai masaukin na cikin jerin sa'ad da ake gudanar da dawo da.

Required permission: 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"
}
Warning: Duk abin da aka rubuta zuwa mai ba da sabis bayan an yi rikodin rikodin an rasa. Ba za'a iya dakatar da dawo da ba.

Lambobin Matsayin Amsawa

200 An sanya aikin cikin jerin gwano
400 An kasa shigar da mai ba da sabis
404 An kasa gano shi, ko kuma yana da alaƙa da wani asusu na daban

Notes