VPS.org API

Dokumentacja REST API

Interfejs API migawek

Wybierzcie etykietowane zdjęcia serwera, wyświetlcie je i usuńcie te, których nie potrzebujecie.

Punkty końcowe 4
Ścieżka bazowa /api/v1/snapshots
DOSTAWAĆ /api/v1/snapshots/

Wyświetl wszystkie migawki

Zwraca zdjęcia na koncie, najnowsze pierwsze, 25 na stronę.

Wymagane zezwolenie: snapshots:list

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Pola odpowiedzi

Pole Typ Opis
uuid string Identifikator odcinku (32 sześciodecydowe znaki, bez pokrycia)
label string Etykieta podana w momencie powstania zdjęcia
server_hostname string Nazwa serwera, z którego został pobrany zdjęciu, lub zerowa, jeśli ten serwer już nie istnieje
ready boolean Prawda po zakończeniu zdjęcia
deleting boolean Prawda podczas procesu usuwania
created_at datetime Czas tworzenia (ISO 8601, UTC)
size_gb number Rozmiar kompromiowany w gigabajtach
DOSTAWAĆ /api/v1/snapshots/{uuid}/

Odbierz odbiornik

Zwraca jeden obiekt z powyższymi polami. Użyj go do ankietowania gotowego po utworzeniu zdjęcia.

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

Odgrywanie roli, odgrywanie roli

Zwraca zrzut rozmieszczonego serwera i zwraca uuid nowego zrzutu. Zrzut jest wymieniony natychmiast, gotowy nastawiony na false.

Wymagane zezwolenie: servers:snapshot

Parametry treści żądania

Parametr Typ Wymagany Opis
action string Tak Musi być zrzut
snapshot_label string Tak Etykieta rozpoznająca zrzut
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"])

Przykładowa odpowiedź

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

Kody statusu odpowiedzi

200 Akcja została zakończona kolejką
400 brak działania lub znaku migania lub serwera jeszcze nie został uruchomiony
402 Brak metody płatności na aktach lub niezapłaconych faktur
404 Nie znaleziono, albo należy do innego konta
USUWAĆ /api/v1/snapshots/{uuid}/

Usuń odcinek

Dodaje w kolejce migawkę do trwałego usuwania. usuwanie jest prawdziwe, dopóki nie zostanie przerwane.

Wymagane zezwolenie: snapshots:delete

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

Kody statusu odpowiedzi

202 Zaakceptowano: wniosek został zaatakowany
404 Nie znaleziono, albo należy do innego konta

Uwagi