VPS.org API

Documentación de API REST

API de ubicaciones

Lista las ubicaciones donde puedes implementar un VPS. Pasa el id de una ubicación como location_id cuando creas un servidor.

Puntos finales 2 endpoints
Ruta base /api/v1/locations
CONSEGUIR /api/v1/locations/

Listar todas las ubicaciones

Recupera una lista de todas las ubicaciones de centro de datos disponibles donde puedes implementar servidores VPS.

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Campos de respuesta

Campo Tipo Descripción
id integer Identificador de ubicación. Utilízalo como location_id cuando crees un servidor.
name string Nombre de ubicación legible por el ser humano
country_name string País en el que se encuentra la ubicación
country_code string Código ISO 3166-1 alfa-2 del país, mayúscula
is_active boolean Si la ubicación está aceptando nuevos servidores

Códigos de estado de respuesta

200 Lista de ubicaciones recuperada con éxito
403 Token API no válido o falta el token o el token carece del permiso requerido
CONSEGUIR /api/v1/locations/{id}/

Obtener una ubicación

Recuperar una única ubicación por su id. La respuesta es un objeto de ubicación con los campos anteriores.

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
}

Dónde se ejecutan sus servidores

Cada servidor VPS.org actualmente se ejecuta en nuestra ubicación de Nueva Jersey, EE.UU., que sirve a clientes en todo el mundo a través de IPv4 e IPv6. Siempre leer el punto final de ubicación en lugar de codificar un id, por lo que su integración recoge nuevas ubicaciones cuando se agregan.