VPS.org API

Dokumentace REST API

API pro snímky

Vezměte označené snímky serveru, vyberte je a smažte ty, které již nepotřebujete.

Koncové body 4
Základní cesta /api/v1/snapshots
ZÍSKAT /api/v1/snapshots/

Zobrazit všechny snímky

Vrací snímky na vašem účtu, nejnovější první, 25 na stránku.

Požadované povolení: snapshots:list

Příklad žádosti

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

Příklad odpovědi

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

Pole odpovědí

Pole Typ Popis zboží
uuid string Identifikátor snímku (32 hexadecimální znaky, žádné pomlčky)
label string Označení zadané při vytvoření snímku
server_hostname string Hostitelské jméno serveru, ze kterého byl snímek převzat, nebo null, pokud server již neexistuje
ready boolean Pravda, jakmile snímek skončí
deleting boolean Pravda, zatímco je smazání v plném proudu
created_at datetime Doba vytvoření (ISO 8601, UTC)
size_gb number Stlačená velikost v gigabytech
ZÍSKAT /api/v1/snapshots/{uuid}/

Sežeň si fotku.

Vrací jeden snímek objekt s polemi výše. Použijte jej k anketě připraven po vytvoření snímku.

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

Vytvořit snímek

Nastaví snímek nasazeného serveru a vrátí uuid nového snímku. Snímek je uveden ihned s připravenou sadou na false.

Požadované povolení: servers:snapshot

Parametry těla požadavku

Parametr Typ Požadovaný Popis zboží
action string Ano To musí být fotka.
snapshot_label string Ano Štítek, který rozpozná snímek
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"])

Příklad odpovědi

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

Kódy stavu odpovědi

200 Akce byla ve frontě.
400 akce nebo snapshot_label chybí, nebo server není nasazen ještě
402 Žádná platební metoda ve spisu nebo nezaplacené faktury
404 Nenalezeno, nebo patří k jinému účtu
VYMAZAT /api/v1/snapshots/{uuid}/

Smazat snímek

Fronta snímek pro trvalé vymazání. Smazání je pravda, dokud není pryč.

Požadované povolení: snapshots:delete

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

Kódy stavu odpovědi

202 Přijato: žádost byla ve frontě
404 Nenalezeno, nebo patří k jinému účtu

Poznámky