VPS.org API

Dokumentácia REST API

API pre lokality

Pri vytváraní servera zadajte ako location_id ID umiestnenia.Predložte ID umiestnenia ako location_id pri vytváraní servera.Presuňte ID umiestnenia ako location_id pri vytváraní servera.

Koncové body 2 endpoints
Základná cesta /api/v1/locations
ZÍSKAŤ /api/v1/locations/

Zoznam všetkých lokalít

Získajte zoznam všetkých dostupných dátových centier, kde môžete nasadiť servery VPS.

Príklad žiadosti

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

Príklad odpovede

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

Polia odpovede

Pole Typ Opis
id integer Identifikátor umiestnenia. Použite ho ako location_id pri vytváraní servera.
name string Názov lokality čitateľný pre človeka
country_name string Krajina, v ktorej sa nachádza lokalita
country_code string Kód krajiny podľa ISO 3166-1 alfa-2, veľké písmená
is_active boolean Či dané umiestnenie prijíma nové servery

Kódy stavu odpovede

200 Zoznam lokalít bol úspešne načítaný
403 Chýbajúci alebo neplatný token API alebo token nemá požadované povolenie
ZÍSKAŤ /api/v1/locations/{id}/

Získať polohu

Získajte jedno miesto podľa jeho id. Odpoveď je jeden objekt umiestnenia s poľami vyššie.

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
}

Kde sú vaše servery spustené

Každý server VPS.org v súčasnosti beží v našom umiestnení v New Jersey v USA, ktoré slúži zákazníkom na celom svete cez IPv4 a IPv6.Vždy čítajte koncový bod umiestnenia namiesto hardkódovania identifikátora, takže vaša integrácia vyzdvihne nové umiestnenia, keď sú pridané.