VPS.org API

Dokumentacja REST API

API lokalizacji

Wyświetl lokalizacje, w których można rozmieszczyć VPS. Przekaż identyfikator lokalizacji jako lokalizację_ id przy tworzeniu serwera.

Punkty końcowe 2 endpoints
Ścieżka bazowa /api/v1/locations
DOSTAWAĆ /api/v1/locations/

Wyświetl wszystkie lokalizacje

Pobierz listę wszystkich dostępnych lokalizacji centrum danych, w których można uruchomić serwery VPS.

Przykładowe żądanie

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

url = "https://admin.vps.org/api/v1/locations/"
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/locations/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const locations = await response.json();
console.log(locations);
$ch = curl_init('https://admin.vps.org/api/v1/locations/');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$locations = json_decode($response, true);
curl_close($ch);

Przykładowa odpowiedź

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "New Jersey",
      "country_name": "United States",
      "country_code": "US",
      "is_active": true
    }
  ]
}

Pola odpowiedzi

Pole Typ Opis
id integer Identyfikator lokalizacji. Użyj go jako lokalizację_ id podczas tworzenia serwera.
name string Nazwa lokalizacji, którą można odczytać przez ludzi
country_name string Kraj, w którym znajduje się miejsce
country_code string Kod kraju ISO 3166-1 alfa-2, wielkie
is_active boolean Czy lokalizacja akceptuje nowe serwery

Kody statusu odpowiedzi

200 Lista lokalizacji została pomyślnie pobrana
403 Brak lub nieprawidłowy token API, lub token brakuje wymaganego pozwolenia
DOSTAWAĆ /api/v1/locations/{id}/

Uzyskać lokalizację

Pobierz jedną lokalizację przez id. Odpowiedź jest obiektem lokalizacji z powyższymi polami.

curl -X GET "https://admin.vps.org/api/v1/locations/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": 1,
  "name": "New Jersey",
  "country_name": "United States",
  "country_code": "US",
  "is_active": true
}

Gdzie działają Twoje serwery

Każdy serwer VPS.org działa obecnie w naszej lokalizacji New Jersey, USA, która obsługuje klientów na całym świecie w IPv4 i IPv6. Zawsze czytaj punkt końcowy zamiast hardcodowania id, więc twoja integracja wybiera nowe lokalizacje po dodaniu.