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 காட்சி முடிந்தவுடன் உண்மை
deleting boolean நீக்குதல் நடந்து கொண்டிருக்கும் போது உண்மை
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 செயல் அல்லது ஸ்னாப்ஷாட்_ லேபிள் காணவில்லை, அல்லது சேவையகம் இன்னும் செயல்படுத்தப்படவில்லை
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 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது

குறிப்புகள்