VPS.org API

REST API skjölun

Myndatökuforritaskil

Taktu merktar skyndimyndir af netþjóni, skráðu þær og eyða þeim sem þú þarft ekki lengur.

Endapunktar 4
Grunnslóð /api/v1/snapshots
FÁ /api/v1/snapshots/

Listi yfir allar skyndimyndir

Sýnir snapshots á reikningnum þínum, nýjustu fyrst, 25 á síðu.

Nauðsynlegt leyfi: snapshots:list

Dæmi um beiðni

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

Dæmi um svar

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

Svarsvið

Field Tegund Lýsing
uuid string Auðkenni skyndimyndar (32 hex stafi, engin tengistrengur)
label string Merki gefið þegar myndin var búin til
server_hostname string Vélarheiti miðlarans sem myndin var tekin frá, eða núll ef miðlarinn er ekki lengur til
ready boolean True þegar myndin er tekin
deleting boolean True meðan eyðing er í gangi
created_at datetime Sköpunartími (ISO 8601, UTC)
size_gb number Þjappað stærð í gígabætum
FÁ /api/v1/snapshots/{uuid}/

Fáðu augnablik

Sýnir eina mynd með fyrirfram gefnum reit. Notaðu þetta til að athuga hvort myndin sé tilbúin eftir að hafa búið til hana.

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

Búa til mynd

Býður upp á mynd af þjóni sem er í notkun og skilar uuid nýju myndarinnar. Myndin er skráð strax með tilbúið stillt á false.

Nauðsynlegt leyfi: servers:snapshot

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
action string Já Verður að vera snapshot
snapshot_label string Já Merki til að þekkja myndina eftir
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"])

Dæmi um svar

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

Kóðar fyrir svörunarstöðu

200 Aðgerðin var sett í biðröð
400 action eða snapshot_ label vantar, eða þjónninn er ekki ennþá í notkun
402 Engin greiðsluaðferð í skránni eða ógreiddar reikningar
404 Fannst ekki, eða það tilheyrir öðrum reikningi
EYÐA /api/v1/snapshots/{uuid}/

Eyða mynd

Biðröð snapshot fyrir varanlega eyðingu. eyðing er satt þar til það er farið.

Nauðsynlegt leyfi: snapshots:delete

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

Kóðar fyrir svörunarstöðu

202 Samþykkt: beiðnin var sett í biðröð
404 Fannst ekki, eða það tilheyrir öðrum reikningi

Athugasemdir