VPS.org API

REST API -dokumentaatio

Snapshots-API

Ota palvelimesta merkittyjä kuvia, luettele ne ja poista ne, joita et enää tarvitse.

Päätepisteet 4
Perusreitti /api/v1/snapshots
SAADA /api/v1/snapshots/

Listaa kaikki tilannekuvat

Palauttaa tililläsi olevat kuvat uusin ensin, 25 sivulla.

Vaadittu lupa: snapshots:list

Esimerkkipyyntö

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

Esimerkkivastaus

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

Vastauskentät

Kenttä Tyyppi Tavaran kuvaus
uuid string Kuvanvaimennuksen tunniste (32 heksadesimaalista merkkiä, ei väliviivaa)
label string Kuvan luontihetkellä annettu merkintä
server_hostname string Kuvan palvelimen nimi otettiin tai nollattiin, jos kyseistä palvelinta ei enää ole olemassa
ready boolean Totta, kun tilannekuva on valmis
deleting boolean Totta, kun poisto on käynnissä
created_at datetime Luontiaika (ISO 8601, UTC)
size_gb number Puristettu koko gigatavuina
SAADA /api/v1/snapshots/{uuid}/

Ota kuva

Palauttaa yhden kuvakohteen yllä olevilla kentillä. Käytä sitä kyselyyn, kun olet luonut kuvan.

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

Luo kuvakaappaus

Odottaa käytössä olevan palvelimen kuvauksia ja palauttaa uuden palvelimen uuidin. Kuva on listattu välittömästi valmiiksi.

Vaadittu lupa: servers:snapshot

Pyynnön rungon parametrit

Muuttuja Tyyppi Pakollinen Tavaran kuvaus
action string Kyllä Kuvan täytyy olla
snapshot_label string Kyllä Etiketti, jolla kuva voidaan tunnistaa
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"])

Esimerkkivastaus

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

Vastauksen tilakoodit

200 Toimintaa jonotettiin
400 toiminto tai spot_label puuttuu tai palvelinta ei ole vielä käytössä
402 Ei maksutapaa tiedostossa tai maksamattomia laskuja
404 Ei löytynyt, tai se kuuluu toiselle tilille
POISTAA /api/v1/snapshots/{uuid}/

Poista kuvakaappaus

Odottaa kuvakaappausta pysyvää poistoa varten. Poistaminen on totta, kunnes se on poissa.

Vaadittu lupa: snapshots:delete

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

Vastauksen tilakoodit

202 Hyväksyttiin: pyyntö jonotettiin
404 Ei löytynyt, tai se kuuluu toiselle tilille

Huomautuksia