VPS.org API

Documentation de l'API REST

API de localisation

Énumérez les emplacements où vous pouvez déployer un VPS. Passez l'identifiant d'un emplacement en tant que location_id lorsque vous créez un serveur.

Points d'extrémité 2 endpoints
Chemin de base /api/v1/locations
OBTENIR /api/v1/locations/

Liste de tous les emplacements

Récupérer une liste de tous les emplacements de datacenter disponibles où vous pouvez déployer des serveurs VPS.

Exemple de requête

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

Exemple de réponse

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

Champs de réponse

Champ Taper Désignation des marchandises
id integer Identificateur de localisation. Utilisez-le comme location_id lors de la création d'un serveur.
name string Nom de l'emplacement lisible par l'homme
country_name string Pays où l'emplacement est
country_code string Code du pays ISO 3166-1 alpha-2, majuscule
is_active boolean Indique si l'emplacement accepte de nouveaux serveurs

Codes d'état de réponse

200 Liste des emplacements récupérés avec succès
403 Jeton API manquant ou invalide, ou le jeton manque la permission requise
OBTENIR /api/v1/locations/{id}/

Obtenir un emplacement

Récupérer un seul emplacement par son id. La réponse est un objet de localisation avec les champs ci-dessus.

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
}

Où vos serveurs courent

Chaque serveur VPS.org fonctionne actuellement dans notre New Jersey, aux États-Unis, qui dessert les clients dans le monde entier sur IPv4 et IPv6. Lisez toujours le point de terminaison des emplacements plutôt que de coder un id, de sorte que votre intégration prend de nouveaux emplacements lorsqu'ils sont ajoutés.