VPS.org API

പരിശോധന എപിഐ സഹായക്കുറിപ്പുകള്‍Query

ബാക്കപ്പുകൾ API

നിങ്ങളുടെ സര്‍വര്‍ ബാക്കപ്പ് ലിസ്റ്റ് ചെയ്യുക, ഒരു പുതിയ ബാക്കപ്പ് തുടങ്ങുക, ഒരു സര്‍വറിനെ ഒന്നില്‍ നിന്നും വീണ്ടെടുക്കുക.

എൻഡ്‌പോയിന്റുകൾ 4
ബേസ് പാത്ത് /api/v1/backups
നേടുക /api/v1/backups/

എല്ലാ ബാക്കപ്പുകളും ലിസ്റ്റുചെയ്യുക

നിങ്ങളുടെ സര്‍വറുകളുടെ എല്ലാ ബാക്കപ്പ്‌കളും, ആദ്യം തന്നെ, പുതിയവയായ 25 ആയി തിരികെ നല്‍കുന്നു. സര്‍വര്‍ ഫില്‍റ്ററൊന്നും ഇല്ല: സര്‍വര്‍_hostname ഉപയോഗിക്കുക അവരെ കൂട്ടുവാന്‍.

അനുവാദം ആവശ്യമുണ്ട്: backups:list

അന്വേഷണ പാരാമീറ്ററുകൾ

പരാമീറ്റര്‍ ടൈപ്പ് ചെയ്യുക ആവശ്യമാണ് വിവരണം
page integer ഇല്ല താളിന്റെ നംബര്‍, 1 മുതല്‍

ഉദാഹരണ അഭ്യർത്ഥന

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

ഉദാഹരണ പ്രതികരണം

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

പ്രതികരണ ഫീൽഡുകൾ

ഫീള്‍ഡ് ടൈപ്പ് ചെയ്യുക വിവരണം
id integer കൈമാറ്റം ചെയ്ത് അവസാന പോയിന്റ് വീണ്ടെടുക്കുവാനുള്ള ബാക്കെന്‍ഡ് തിരിച്ചറിയല്‍
server_hostname string സര്‍വറിന്റെ ഹോസ്റ്റിന്റെ ഹോസ്റ്റിന്റെ പേരു് എടുക്കപ്പെട്ടു
name string കരുതല്‍ ശേഖരം ഫയല്‍ നാമം
size_gb number ഗ്ലേസ്ബാറ്റുകളില്‍ ചെറുതാക്കിയ വലിപ്പം
deletion_date datetime കരുതല്‍ തനിയെ നീക്കം ചെയ്യുമ്പോള്‍
days_remaining integer _date to to folder
created_at datetime Creation time (ISO 8601, UTC)

പ്രതികരണ സ്റ്റാറ്റസ് കോഡുകൾ

200 വിജയകരമായി കരുതല്‍ ലിസ്റ്റ്
403 API അടയാളം ലഭ്യമല്ല അല്ലെങ്കില്‍ ആവശ്യമുളള സൂചനയ്ക്ക് ലഭ്യമല്ല
നേടുക /api/v1/backups/{id}/

ഒരു ബാക്കപ്പ് എടുക്കുക

ഒരു ബാക്കപ്പ് ബാക്കപ്പ് ഫീല്‍ഡ് തിരികെ തരുന്നു.

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

ഒരു കരുതല്‍ ഉണ്ടാക്കുക

ഒരു വിതരണ സേവകന്റെ ഒരു ബാക്കപ്പ് റേറ്റുന്നു. ആവശ്യമുളള ശരീരമൊന്നും ആവശ്യമില്ല. ഇതു് അവസാനിച്ച ശേഷം കരുതല്‍ കാണപ്പെടുന്നു. ഇതു് ഡിസ്കിന്റെ ഉപയോഗം അനുസരിച്ച് ചില മിനിറ്റ് എടുക്കാം.

അനുവാദം ആവശ്യമുണ്ട്: 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())

ഉദാഹരണ പ്രതികരണം

{
  "message": "Backup queued successfully"
}

പ്രതികരണ സ്റ്റാറ്റസ് കോഡുകൾ

200 നടപടി ക്രമീകരിച്ചിരുന്നു
400 സര്‍വര്‍ ഇതുവരെ കമ്പ്യൂട്ടറില്‍ പെടുത്തിയിട്ടില്ല
402 ഫയലില്‍ പണ രീതിയില്ല, പ്ളഗറുകളില്‍ ലഭ്യമല്ല
404 ഇല്ല, അല്ലെങ്കില്‍ മറ്റൊരു പ്രമാണം മാത്രമേ അവര്‍ക്ക് ലഭിക്കുകയുള്ളൂ.
പോസ്റ്റ് /api/v1/backups/{id}/restore/

ഒരു ബാക്കെന്‍ഡ് ബാക്കപ്പ് ലഭ്യമാക്കുക

ബാക്കപ്പ് എടുക്കുന്നതു് സര്‍വറില്‍ നിന്നും എടുത്തിരിക്കുന്ന ബാക്കപ്പ് നിര്‍ത്തി, കരുതല്‍ ബാക്കപ്പ് ഉപയോഗിച്ച് അതിന്റെ ഡിസ്ക് മാറ്റി വീണ്ടും തുടങ്ങുന്നു. ആവശ്യ‌മായ ശരീരമൊന്നും ആവശ്യമില്ല. വീണ്ടെടുക്കല്‍ പ്രവര്‍ത്തിക്കുന്നപ്പോള്‍ സര്‍വര്‍ സ്ഥിതി സൂചിക റെയിന്റ് ചെയ്യുന്നു.

അനുവാദം ആവശ്യമുണ്ട്: 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"
}
മുന്നറിയിപ്പ്: ബാക്കപ്പ് നഷ്ടപ്പെട്ട ശേഷം സര്‍വറില്‍ എഴുതപ്പെട്ടതെല്ലാം. വീണ്ടെടുക്കുവാന്‍ സാധ്യമല്ല.

പ്രതികരണ സ്റ്റാറ്റസ് കോഡുകൾ

200 നടപടി ക്രമീകരിച്ചിരുന്നു
400 സര്‍വര്‍ ഇതുവരെ കമ്പ്യൂട്ടറില്‍ പെടുത്തിയിട്ടില്ല
404 ഇല്ല, അല്ലെങ്കില്‍ മറ്റൊരു പ്രമാണം മാത്രമേ അവര്‍ക്ക് ലഭിക്കുകയുള്ളൂ.

കുറിപ്പുകള്‍