API de Localizações

Enumere os locais onde você pode implantar um VPS. Passar o id de um local como location_id quando você cria um servidor.

Pontos finais 2 endpoints

Caminho base /api/v1/locations

PEGAR /api/v1/locations/

Listar todos os locais

Obtenha uma lista de todos os locais de datacenter disponíveis onde você pode implantar servidores VPS.

Exemplo de solicitação

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

Exemplo de resposta

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

Campos de resposta

Campo	Tipo	Descrição
`id`	integer	Identificador de localização. Use-o como local_id ao criar um servidor.
`name`	string	Nome de local legível por ser humano
`country_name`	string	País em que está a localização
`country_code`	string	Código do país ISO 3166-1 alfa-2, maiúscula
`is_active`	boolean	Se a localização está a aceitar novos servidores

Códigos de status de resposta

200	Lista de locais recuperada com sucesso
403	Token API faltante ou inválida, ou o token carece da permissão requerida

PEGAR /api/v1/locations/{id}/

Obter uma localização

Recuperar uma única localização por seu id. A resposta é um objeto de localização com os campos acima.

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
}

Onde os seus servidores Executem

Cada servidor VPS.org atualmente funciona em nossa localização New Jersey, EUA, que serve clientes em todo o mundo através do IPv4 e IPv6. Leia sempre os locais ponto final em vez de hardcoding um id, por isso sua integração recolhe novos locais quando eles são adicionados.

VPS.org API