VPS.org API

REST API ලේඛන

ස්නැප්ෂොට් API

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

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

සියලුම ස්නැප්ෂොට් ලැයිස්තුගත කරන්න

ඔබේ ගිණුමේ ස්නයිප්ස් ආපසු, නවතම පළමු, පිටුවකට 25.

අවසර අවශ්‍යයි: snapshots:list

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

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/snapshots/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/snapshots/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for snapshot in response.json()["results"]:
    print(snapshot["uuid"], snapshot["label"], snapshot["ready"])
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b",
      "label": "before-upgrade",
      "server_hostname": "web-01",
      "ready": true,
      "deleting": false,
      "created_at": "2026-09-14T18:30:00.000000Z",
      "size_gb": 3.4
    }
  ]
}

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

ක්ෂේත්‍රය වර්ගය විස්තරය
uuid string ස්නොට් හඳුනාගැනීම (32 hex අකුරු, හයිෆන් නැත)
label string ස්නොට් පටය නිර්මාණය කල විට ලබාදුන් ලේබලය
server_hostname string ස්නොට් පටය ලබාගත් ධාරකයේ ධාරක නාමය, හෝ එම ධාරකය තවදුරටත් නොපවතී නම් ශුන්‍ය
ready boolean ඡායාරූපය අවසන් වූ පසු True
deleting boolean මකන්න ක්‍රියාත්මක වන විට True
created_at datetime නිර්මාණය කිරීමේ වේලාව (ISO 8601, UTC)
size_gb number සම්පීඩන ප්‍රමාණය ගිගාබයිට් වලින්
ලබා ගන්න /api/v1/snapshots/{uuid}/

ස්නොට් ලබාගන්න

ඉහත ක්ෂේත්ර සමග එක් ස්නයිප් වස්තුව ආපසු. ස්නයිප් නිර්මාණය කිරීමෙන් පසු සූදානම් පෝල් එය භාවිතා කරන්න.

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
තැපැල් /api/v1/servers/{uuid}/snapshot/

ස්නොට් පටයක් නිර්මාණය කරන්න

ස්ථාපිත සේවාදායකයේ ස්නොට් පටයක් පෝලිමේ තබයි සහ නව ස්නෝට් පටයේ uuid යළි ලබාදෙයි. ස්නෝට් පටය ව්‍යාජ ලෙස සැකසූ සූදානම් සමඟ වහාම ලැයිස්තුගත වේ.

අවසර අවශ්‍යයි: servers:snapshot

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

පරාමිතීන් වර්ගය අවශ්‍යයි විස්තරය
action string ඔව් ස්නොට් එකක් විය යුතුයි
snapshot_label string ඔව් ස්නොට් ඡායාරූපය හඳුනාගැනීමට ලේබලයක්
cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/snapshot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "snapshot", "snapshot_label": "before-upgrade"}'
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/snapshot/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
data = {"action": "snapshot", "snapshot_label": "before-upgrade"}

response = requests.post(url, headers=headers, json=data)
print(response.json()["snapshot_uuid"])

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

{
  "message": "Snapshot queued successfully",
  "snapshot_uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b"
}

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

200 ක්‍රියාව පෝලිමේ තැබිණි
400 ක්‍රියාව හෝ snapshot_label අතුරුදහන් වී ඇත, හෝ ධාරකය තවමත් ස්ථාපනය කර නැත
402 ගොනුව මත ගෙවීම් ක්රමයක් නැත, හෝ ගෙවීම් නොකළ ඉන්වොයිසි
404 හමු නොවිනි, හෝ එය වෙනත් ගිණුමක් සතුව ඇත
මකන්න /api/v1/snapshots/{uuid}/

ස්නොට් පටයක් මකන්න

ස්ථිර මකන්න සඳහා ස්නෝට් පේලිය. එය ගියේ තෙක් මකන්න සැබෑ වේ.

අවසර අවශ්‍යයි: snapshots:delete

curl -X DELETE "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Snapshot deletion queued"
}

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

202 පිළිගත්: ඉල්ලීම පෝලිමේ තැබිණි
404 හමු නොවිනි, හෝ එය වෙනත් ගිණුමක් සතුව ඇත

සටහන්