VPS.org API

REST API ලේඛන

උපස්ථ API

ඔබේ සේවාදායකයේ පිටපත් ලැයිස්තුගත කරන්න, නව පිටපතක් ආරම්භ කරන්න සහ එක් සේවාදායකයක් නැවත ලබා ගන්න.

අන්ත ලක්ෂ්‍ය 4
පාදක මාර්ගය /api/v1/backups
ලබා ගන්න /api/v1/backups/

සියලුම උපස්ථ ලැයිස්තුගත කරන්න

ඔබේ සියලු සේවාදායකයන් පිටපත් ආපසු, නවතම පළමු, 25 පිටුවකට. කිසිදු සේවාදායක පෙරහන් නැත: ඔවුන් කණ්ඩායම් කිරීමට server_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 මකන දිනය දක්වා ඉතිරි දින ගණන (_d)
created_at datetime නිර්මාණය කිරීමේ වේලාව (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 හමු නොවිනි, හෝ එය වෙනත් ගිණුමක් සතුව ඇත

සටහන්