VPS.org API

REST API dokumentacija

Vietovių API

Nurodyti vietas, kuriose galite įdiegti VPS. Kurdami serverį, pereikite vietos id kaip vietovę_ id.

Galutiniai taškai 2 endpoints
Bazinis kelias /api/v1/locations
GAUTI /api/v1/locations/

Išvardinti visas vietas

Gauti visų prieinamų duomenų centrų vietų, kuriose galite dislokuoti VPS serverius, sąrašą.

Prašymo pavyzdys

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

Atsakymo pavyzdys

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

Atsakymo laukai

Laukas Tipas Aprašymas
id integer Vietos identifikatorius. Kuriant serverį, naudoti jį kaip location_id.
name string Žmogiškas vietovės pavadinimas
country_name string Šalis, kurioje yra vietovė
country_code string ISO 3166-1 alpha-2 country code, uppercase
is_active boolean Ar vieta priima naujus serverius

Atsakymo būsenos kodai

200 Vietovių sąrašas sėkmingai gautas
403 Trūksta arba netinkamas API žetonas, arba žetonas neturi reikiamo leidimo
GAUTI /api/v1/locations/{id}/

Gauti vietovę

Iš ID gauti vieną vietą. Atsakas yra vienas iš vietos objektų, turinčių aukščiau esančius laukus.

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
}

Kur veikia jūsų serveriai

Kiekvienas VPS.org serveris šiuo metu veikia mūsų New Jersey, JAV vietoje, kuri tarnauja klientams visame pasaulyje per IPv4 ir IPv6. Visada skaityti vietas, o ne kietas kodavimas id, todėl jūsų integracija parenka naujas vietas, kai jie yra pridėti.