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 վեցերորդական այբուբեն, առանց կապի)
label string Ծածկագիրը, որը տրվել է նկարի ստեղծման ժամանակ
server_hostname string սերվերի սերվերի անունը, որտեղից նկարը վերցվել է, կամ null, եթե սերվերը այլևս չկա
ready boolean True, երբ նկարը ավարտվել է
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/

Կերտել նկար

Առաջարկում է սերվերի նկարը և վերադարձնում նոր նկարի uuid-ը։ նկարը միանգամից ցուցակագրվում է, երբ պատրաստ է, և false-ը դրված է։

Պահանջվող թույլտվություն: 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 action կամ 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 Չգտնվեց կամ պատկանում է այլ հաշվին

Ծանոթագրություններ