VPS.org API

@ action

Hotunan API na Hotuna

Ka yi amfani da hotunan da aka yi da sunan mai ba da sabis, ka lissafa su kuma ka share waɗanda ba ka buƙatar su ba.

Ƙarshen maki 4
Hanyar Tushe /api/v1/snapshots
SAMU /api/v1/snapshots/

Jera Duk Hotunan Hotuna

Mai mayar da hotunan da aka yi a cikin asusunka, mafi sabon farko, 25 a kowace fuska.

Required permission: snapshots:list

Buƙatar Misali

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);

Misalin Amsar

{
  "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
    }
  ]
}

Wuraren Amsawa

@ action Nau'i @ action
uuid string Mai gane hoton hoto (alamomin hex 32, ba da haɗe-haɗe ba)
label string An ba da alamar lokacin da aka yi hoton
server_hostname string Sunan mai masaukin mai watsawa wanda aka dauka daga, ko kuma ba'a idan wannan mai watsawa bai kasance ba
ready boolean Gaskiya idan an kammala hoton hoto
deleting boolean True while a deletion is in progress
created_at datetime Lokacin ƙirƙira (ISO 8601, UTC)
size_gb number Girman da aka rufe cikin gigabaituna
SAMU /api/v1/snapshots/{uuid}/

Get a Snapshot

Mai mayar da wani abu na hoton kwafin kwamfuta tare da fannoni na sama. Ka yi amfani da shi wajen tambaya da shirye bayan ƙirƙirar hoton kwafin kwamfuta.

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

Create a Snapshot

Yana sanya wani hoton kwanan wata na mai ba da sabis da aka shigar a cikin jerin kuma yana mayar da uuid na sabon hoton kwanan wata. An lissafa hoton kwanan wata a hankali tare da daidaita shirya zuwa ƙarya.

Required permission: servers:snapshot

Sigogin Jiki na Neman

Parameters Nau'i Ana buƙata @ action
action string Ee Ya kamata ya zama hoton hoto
snapshot_label string Ee Wani label da za'a iya gane hoton kwafin da shi
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"])

Misalin Amsar

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

Lambobin Matsayin Amsawa

200 An sanya aikin cikin jerin gwano
400 Action or snapshot_label missing, or the server is not deployed yet
402 Babu hanyar biyan kuɗi a cikin fayil, ko kuma ba'a biya ba
404 An kasa gano shi, ko kuma yana da alaƙa da wani asusu na daban
Goge /api/v1/snapshots/{uuid}/

Delete a Snapshot

Ana yin kwafa na hoto na kwanan nan domin cirewa har abada. cirewa yana da gaskiya har ya tafi.

Required permission: snapshots:delete

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

Lambobin Matsayin Amsawa

202 Accepted: the request was queued
404 An kasa gano shi, ko kuma yana da alaƙa da wani asusu na daban

Notes