VPS.org API

REST API ලේඛනගත කිරීම

උපස්ථ API

සේවාදායක උපස්ථ ක්‍රමලේඛනගතව කළමනාකරණය කරන්න. ඔබගේ සේවාදායකයන් සඳහා උපස්ථ ලැයිස්තුගත කරන්න, සාදන්න, ප්‍රතිසාධනය කරන්න සහ මකන්න.

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

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

ඔබගේ සේවාදායකයන් හරහා ඇති සියලුම උපස්ථ ලැයිස්තුවක් ලබා ගන්න.

විමසුම් පරාමිතීන්

පරාමිතිය වර්ගය අවශ්‍යයි විස්තර
server_id integer නැත සේවාදායක හැඳුනුම්පත අනුව උපස්ථ පෙරහන් කරන්න
backup_type string නැත වර්ගය අනුව පෙරහන: manual , automatic

උදාහරණ ඉල්ලීම

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/?server_id=12345" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
params = {"server_id": 12345}

response = requests.get(url, headers=headers, params=params)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/?server_id=12345', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const backups = await response.json();
console.log(backups);

උදාහරණ ප්‍රතිචාරය

{
  "count": 3,
  "results": [
    {
      "id": 501,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4523,
      "created_at": "2025-01-16T03:00:00Z",
      "expires_at": "2025-02-16T03:00:00Z",
      "description": "Automatic daily backup"
    },
    {
      "id": 499,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "manual",
      "status": "completed",
      "size_mb": 4456,
      "created_at": "2025-01-14T10:30:00Z",
      "expires_at": null,
      "description": "Pre-update backup"
    },
    {
      "id": 495,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4389,
      "created_at": "2025-01-15T03:00:00Z",
      "expires_at": "2025-02-15T03:00:00Z",
      "description": "Automatic daily backup"
    }
  ]
}

ප්‍රතිචාර තත්ව කේත

200 උපස්ථ ලැයිස්තුව සාර්ථකව ලබා ගන්නා ලදී.
401 අනවසර - වලංගු නොවන හෝ නැතිවූ සත්‍යාපන ටෝකනය
තැපැල් /api/v1/backups/

අතින් උපස්ථයක් සාදන්න

සේවාදායකයක අතින් උපස්ථයක් සාදන්න. අතින් උපස්ථ ස්වයංක්‍රීයව කල් ඉකුත් නොවේ.

ඉල්ලීම් ශරීර පරාමිතීන්

පරාමිතිය වර්ගය අවශ්‍යයි විස්තර
server_id integer ඔව් උපස්ථ කිරීමට සේවාදායකයේ හැඳුනුම්පත
description string නැත උපස්ථය සඳහා විකල්ප විස්තරය

උදාහරණ ඉල්ලීම

cURL
Python
JavaScript
PHP
curl -X POST "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": 12345,
    "description": "Pre-deployment backup"
  }'
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "server_id": 12345,
    "description": "Pre-deployment backup"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    server_id: 12345,
    description: 'Pre-deployment backup'
  })
});

const backup = await response.json();
console.log(backup);
$data = [
    'server_id' => 12345,
    'description' => 'Pre-deployment backup'
];

$ch = curl_init('https://admin.vps.org/api/v1/backups/');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$backup = json_decode($response, true);
curl_close($ch);

උදාහරණ ප්‍රතිචාරය

{
  "id": 502,
  "server": {
    "id": 12345,
    "name": "web-server-01"
  },
  "backup_type": "manual",
  "status": "in_progress",
  "size_mb": null,
  "created_at": "2025-01-16T15:45:00Z",
  "expires_at": null,
  "description": "Pre-deployment backup",
  "message": "Backup is being created. This may take several minutes depending on server size."
}

ප්‍රතිචාර තත්ව කේත

201 උපස්ථ නිර්මාණය සාර්ථකව ආරම්භ කරන ලදී.
400 වැරදි ඉල්ලීම - අවලංගු පරාමිතීන් හෝ විකෘති ඉල්ලීමක්
401 අනවසර - වලංගු නොවන හෝ නැතිවූ සත්‍යාපන ටෝකනය
404 හමු නොවීය - සේවාදායකය නොපවතී.
සටහන: ඔබට සේවාදායකයකට උපරිම වශයෙන් අතින් උපස්ථ 10ක් තබා ගත හැකිය. ඔබගේ සැලැස්මේ උපස්ථ රඳවා ගැනීමේ ප්‍රතිපත්තිය මත පදනම්ව (සාමාන්‍යයෙන් දින 7-30) ස්වයංක්‍රීය උපස්ථ රඳවා ගනු ලැබේ.
මකන්න /api/v1/backups/{backup_id}/

උපස්ථය මකන්න

උපස්ථයක් ස්ථිරවම මකන්න. මෙම ක්‍රියාව අහෝසි කළ නොහැක.

මාර්ග පරාමිතීන්

පරාමිතිය වර්ගය අවශ්‍යයි විස්තර
backup_id integer ඔව් අනන්‍ය උපස්ථ හැඳුනුම්පත

උදාහරණ ඉල්ලීම

cURL
Python
JavaScript
curl -X DELETE "https://admin.vps.org/api/v1/backups/501/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

backup_id = 501
url = f"https://admin.vps.org/api/v1/backups/{backup_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)
const backupId = 501;
const response = await fetch(`https://admin.vps.org/api/v1/backups/${backupId}/`, {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

console.log(response.status);

ප්‍රතිචාර තත්ව කේත

204 උපස්ථය සාර්ථකව මැකුවා
401 අනවසර - වලංගු නොවන හෝ නැතිවූ සත්‍යාපන ටෝකනය
404 හමු නොවීය - උපස්ථය නොපවතී.
අවවාදයයි: උපස්ථයක් මැකීම ස්ථිර වන අතර එය අහෝසි කළ නොහැක. එය මැකීමට පෙර ඔබට තවදුරටත් මෙම උපස්ථය අවශ්‍ය නොවන බවට වග බලා ගන්න.

උපස්ථ වලින් ප්‍රතිසාධනය කරමින්

උපස්ථයකින් සේවාදායකයක් ප්‍රතිසාධනය කිරීමට, සේවාදායක API ප්‍රතිසාධන අන්ත ලක්ෂ්‍යය භාවිතා කරන්න:

POST /api/v1/servers/{server_id}/restore/
{
  "backup_id": 501
}

සේවාදායක ප්‍රතිසාධනය පිළිබඳ සවිස්තරාත්මක තොරතුරු සඳහා, බලන්න සේවාදායක API ලේඛන.

උපස්ථ හොඳම පිළිවෙත්