Dokumentacja API
Użyj operacji API i interpretuj ich wyniki
Przeczytaj dostępne punkty końcowe, zasady idempotentności, odpowiedzi akcji w kolejce i bieżące limity śledzenia operacji.
Na tej stronie
Zanim zaczniesz
- Ważna sesja oraz, w przypadku chronionych zmian, jej token CSRF.
- Identyfikatory pobrane z bieżącego katalogu lub uwierzytelnionych odpowiedzi API.
- Unikalny klucz idempotentności dla każdego zamówienia, wypłaty lub akcji sprzętowej.
Przeczytaj konto przed jego zmianą
Użyj punktów końcowych odczytu, aby potwierdzić konto, saldo i zasób docelowy. GET /api/v1/me zwraca nazwę użytkownika, saldoUsd i csrfToken sesji. Identyfikatory zasobów są specyficzne dla konta; użyj identyfikatora serwera lub sieci zwróconego dla bieżącego konta, zamiast kopiować wartość z innego środowiska.
Obecny API to kompaktowy interfejs konta, a nie kompletna platforma zadań asynchronicznych. Zapisuj referencje z udanych zapisów we własnych zapisach. Nie ma punktu końcowego do listowania wszystkich zamówień, sprawdzania konkretnej akcji w kolejce ani pobierania najnowszego statusu przeglądu wypłaty.
| Odczytaj punkt końcowy | Zwrócone dane |
|---|---|
| GET /api/v1/ledger | Najnowsze wpisy księgi 100, najnowsze pierwsze; brak umowy paginacji. |
| GET /api/v1/servers | Serwery nie zakończone, stan, region, paidThrough, graceUntil i autoRenew. |
| GET /api/v1/network | Przypisane adresy, długości prefiksów, wartości PTR i powiązane identyfikatory serwerów. |
| GET /api/health | Podstawowe usługi i liczba katalogowa; brak gwarancji zdrowia konta lub serwera fizycznego. |
Użyj pasującego punktu końcowego zmiany
Obsługiwane akcje serwera to restart, power_off, ponowna instalacja, mount_iso, kvm i rotate_root_password. Niestandardowy adres URL ISO musi używać publicznego HTTPS bez osadzonych poświadczeń. Okres zamówienia jest tygodniowy lub miesięczny, co oznacza siedem lub trzydzieści dni. Cena, rabaty, środki i pojemność są sprawdzane przez usługę; nie wysyłaj ceny obliczonej przez klienta jako wiążącej.
| Punkt końcowy | Pola żądania i wynik |
|---|---|
| POST /api/v1/orders | configId, regionId, osId, termin, ilość; opcjonalnie sshPublicKey. Zwraca identyfikator zamówienia i stan ACCEPTED. |
| POST /api/v1/deposit-addresses | zasób. Zwraca adres, zasób, sieć, wymagane potwierdzenia i tryb lub błąd niedostępności rozliczenia. |
| POST /api/v1/withdrawals | zasób, cel, usd. Zwraca id i PENDING_REVIEW; saldo jest wstrzymane. |
| POST /api/v1/servers/{id}/actions | akcja; isoUrl dla mount_iso. Zwraca identyfikator akcji i stan QUEUED. |
| PUT /api/v1/servers/{id}/ddos | tryb: BASELINE lub ADVANCED. Zwraca QUEUED lub UNCHANGED oraz quoteRequired. |
| PUT /api/v1/network/{id}/rdns | ptr lub pusta wartość, aby wyczyścić. Zwraca przechowywaną wartość PTR. |
Spraw, by ponowienia były celowe
Zamówienia, wypłaty, akcje serwera i żądania DDoS wymagają klucza idempotentności. Użyj 8–100 liter, cyfr, myślników lub podkreśleń i przydziel nowy klucz dla każdej odrębnej zamierzonej operacji. Zachowaj oryginalny klucz, zasób i ładunek przed wysłaniem, aby można było zbadać niepewną odpowiedź.
Zamówienia mogą odtworzyć istniejący wynik dla tego samego klucza i znormalizowanego żądania; zmienione szczegóły zamówienia powodują konflikt. Odtworzenia akcji serwera zwracają istniejącą akcję, gdy są kompatybilne. Zachowaj unikalność kluczy akcji na wszystkich serwerach na koncie. Wypłaty zgłaszają konflikt, gdy są już zarejestrowane, zamiast zwracać oryginalne żądanie jako sukces.
POST /api/v1/servers/{serverId}/actions HTTP/1.1
Content-Type: application/json
x-csrf-token: <current-session-token>
Idempotency-Key: <unique-operation-key>
Cookie: <current-session-cookies>
{"action":"reboot"}Odróżnij akceptację od ukończenia
Odpowiedź 202 QUEUED potwierdza, że żądanie sprzętowe zostało zarejestrowane. Nie zawiera działającego adresu URL KVM, zastępczego hasła root ani dowodu ponownego uruchomienia maszyny. Podobnie ACCEPTED rejestruje zamówienie wchodzące w fazę provisioningu; PENDING_REVIEW rejestruje wypłatę oczekującą na weryfikację operatora. Zachowaj zwrócony identyfikator, pytając o wykonanie.
W tej wersji nie ma trasy odpytywania statusu działań. W razie potrzeby ponownie odczytaj dane serwera lub sieci i uzyskaj potwierdzenie operatora dla efektów fizycznych. Sam zapisany PTR lub preferencja DDoS nie jest pomiarem publicznego DNS ani aktywnej ochrony sieci.
Reaguj na awarie bez powielania pracy
- Błąd walidacji 400: popraw udokumentowane pola przed ponownym przesłaniem.
- 401 lub 403: napraw uwierzytelnianie sesji lub weryfikację CSRF przed ponowieniem próby.
- 404: zweryfikuj, czy identyfikator zasobu należy do zalogowanego konta.
- 409: sprawdź kod błędu; niewystarczające saldo, wyczerpana pojemność i konflikty idempotencji wymagają różnych reakcji.
- 502 lub 503 przy depozytach: nie zwrócono użytecznego nowego adresu; nie inicjuj transferu.
- Limit czasu lub nieczytelna odpowiedź: sprawdź dostępne rekordy konta i zachowaj oryginalne szczegóły żądania. Nie twórz ślepo nowego klucza operacji.