VPS.org API

Dokumentacja REST API

VPS.org API Dokumentacja

Pełna dokumentacja interfejsu API REST do zarządzania serwerami VPS, domenami, DNS, kopiami zapasowymi i nie tylko.

Podstawowy adres URL https://admin.vps.org/api/v1
Uwierzytelnianie Token okaziciela
Wersja v1
Format JSON

Rozpoczęcie pracy

Interfejs API VPS.org umożliwia programowe zarządzanie wszystkimi aspektami infrastruktury hostingu VPS, w tym serwerami, domenami, rekordami DNS, kopiami zapasowymi i migawkami.

Uwierzytelnianie

Wszystkie żądania API wymagają uwierzytelnienia za pomocą tokena Bearer. Możesz wygenerować swój token API w ustawieniach konta pod adresem admin.vps.org/account/developers/.

cURL
Python
JavaScript
curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

Każdy token posiada swoje prawa, takie jak serwery:list lub dns:*. Żądanie, które wymaga zezwolenia, że token nie ma, jest odmówione z 403 i wymagane_permisji pola nazwę brakującego pozwolenia. Odnośnik dozwoleń

Ograniczanie szybkości transmisji

Wnioski o uwierzytelnienie są ograniczone do 1000 na godzinę na konto. Nieautentyfikowane żądania są ograniczone do 100 na godzinę na adres IP. Żądanie nad granicą otrzymuje 429 z nagłówkiem Powtórz-After, który daje liczbę sekund do oczekiwania. Nie wysłano zagłówków ograniczeń stawek w przypadku udanych odpowiedzi.

Pogadania

Lista punktów końcowych zwraca obiekt z liczbą, następną, poprzednią i wynikią, 25 pozycji na stronę. Przekaż stronę, aby przenieść się między stronami lub śledzić następny URL aż do momentu nule. Lista serwerów akceptuje również do 100 rozmiarów strony.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

Obsługa błędów

Interfejs API wykorzystuje standardowe kody stanu HTTP do sygnalizowania powodzenia lub niepowodzenia:

Kod statusu Opis
200 Sukces – żądanie zostało pomyślnie zrealizowane
201 Utworzono — zasób został pomyślnie utworzony
400 Błędne żądanie – nieprawidłowe parametry lub błędnie sformatowane żądanie
202, 204 Przyjęty i usunięty w kolejce (202) lub usunięty bez odpowiedzi (204)
402 Wymagana płatność: brak metody płatności na pliku, niezapłacone faktury lub odmowy wstępnej autoryzacji karty
403 Zakazane: brak tokena, nieprawidłowy lub wygasł lub brak wymaganego pozwolenia. Niepoprawne uwierzytelnienie również zwraca 403, nie 401.
404 Nie znaleziono – zasób nie istnieje
409 Konflikt: np. zmiana rozmiaru już trwa, niewystarczająca pojemność lub już uruchomione rozmieszczenie
429 Zbyt wiele żądań – przekroczono limit szybkości
500 Wewnętrzny błąd serwera – coś poszło nie tak po naszej stronie
503 Usługa Niedostępna: tymczasowy problem. Powtórz, honorowanie powtórzonego po wysłaniu.

Ciała błędów to JSON. Większość ma pola szczegółowe lub pole błędu, czasami z wiadomością; błędy walidacji wykazują problemy według nazwy pola.

Kategorie API

Przeglądaj naszą dokumentację API według kategorii:

API serwerów 15 Punkty końcowe

Tworzenie, inspekcja, zasilanie, zmiana rozmiaru i usuwanie serwerów, resetowanie hasła root, ustaw odwrotny DNS, uruchomienie poleceń i zarządzanie klawiszami SSH.

Wyświetl dokumentację
API kopii zapasowych 4 Punkty końcowe

Wyświetla kopie zapasowe serwera, uruchamia nowe kopie zapasowe i przywraca serwer z kopii zapasowej.

Wyświetl dokumentację
Interfejs API migawek 4 Punkty końcowe

Wyświetla etykietowane zdjęcia serwera, wypisuje je i usuwa.

Wyświetl dokumentację
API planów 2 Punkty końcowe

Pobierz dostępne plany VPS i informacje o cenach. Uzyskaj szczegółowe informacje o zasobach, cenach i dostępności.

Wyświetl dokumentację
API systemów operacyjnych 2 Punkty końcowe

Wyświetla systemy operacyjne i wersje, które można zainstalować, takie jak Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora i Alpine.

Wyświetl dokumentację
API domen 7 Punkty końcowe

Sprawdź dostępność, rejestrację i odnowienie domen, oraz ustaw serwery nazw i automatycznie odnawiania.

Wyświetl dokumentację
DNS API 13 Punkty końcowe

Stwórz strefy DNS i utwórz, aktualizuj i usuń ich A, A, CNAME, MX, TXT, SRV, CAA i inne zapisy.

Wyświetl dokumentację
API lokalizacji 2 Punkty końcowe

Wyświetl lokalizacje dostępne do rozmieszczenia serwera.

Wyświetl dokumentację
Rachunek 1 Punkty końcowe

Pobierz profil konta i dane API tokena. Określ, do którego konta należy tokena i sprawdź jego uprawnienia.

Wyświetl dokumentację
Afiliany 7 Punkty końcowe

Wciągnij saldo partnerskie, referencje, prowizje i wypłaty do własnej sprawozdawczości, zmieni ustawienia wypłaty i zażądaj wypłaty.

Wyświetl dokumentację

Więcej punktów końcowych

API posiada również punkty końcowe dla rozmieszczenia aplikacji (/api/v1/deploploy-configs/ i /api/v1/deplopments /). Nie są one jeszcze opisywane na tych stronach; interaktywny opis odniesienia wykazuje każdy punkt końcowy, generowany z żywego API.

Otwórz interaktywne odniesienie API

Potrzebujesz pomocy?

Jeśli masz pytania lub potrzebujesz pomocy z API, nie wahaj się skontaktować z nami: