VPS.org API

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

സ്നാപ്പ്ഷോട്ട് 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 ഹെക്സാഡെസിബിളിറ്റി അക്ഷരങ്ങള്‍, ഹിപ്ഫെന്‍കളില്ല)
label string സൈന്‍ഡ് സൃഷ്ടിക്കപ്പെട്ടപ്പോള്‍ ലേബല്‍ നല്‍കിയിരിക്കുന്നു
server_hostname string സര്‍വറിന്റെ ഹോസ്റ്റിന്റെ ഹോസ്റ്റിന്റെ പേരു്, ആ സര്‍വര്‍ ഇനി ലഭ്യമല്ലെങ്കില്‍, അല്ലെങ്കില്‍ നീക്കം ചെയ്തിരിയ്ക്കുന്നു.
ready boolean സ്കെയില മുഴുമിച്ചു കഴിഞ്ഞാൽ ശരി
deleting boolean ഒരു ട്രൂപ്പ് പുരോഗതിയില്‍ ആയിരിക്കുമ്പോള്‍ ശരി
created_at datetime Creation time (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/

ഒരു സ്നാപ്ഷെറ്റ് ഉണ്ടാക്കുക

ഒരു സിമുലേറ്റര്‍ സര്‍വറിന്റെ ഒരു സ്കെയിലുകള്‍ ക്രമീകരിച്ച് പുതിയ സ്കെയിലിന്റെ യൂഡി നല്‍കുന്നു. ഈ സ്കോട്ട്ലിപ്രോഷന്‍ ശരിയായി തയ്യാറാക്കിയിരിക്കുന്നതായിട്ട് വ്യക്തമാക്കുന്നു.

അനുവാദം ആവശ്യമുണ്ട്: 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 പ്രവര്‍ത്തനം അല്ലെങ്കില്‍ send_type ലഭ്യമല്ല, അല്ലെങ്കില്‍ സര്‍വര്‍ ഇതുവരെ കംപ്രസ്സ് ചെയ്തിട്ടില്ല
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 ഇല്ല, അല്ലെങ്കില്‍ മറ്റൊരു പ്രമാണം മാത്രമേ അവര്‍ക്ക് ലഭിക്കുകയുള്ളൂ.

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