Documentação da API do VPS.org

Começando

A API do VPS.org permite que você gerencie programaticamente todos os aspectos da sua infraestrutura de hospedagem VPS, incluindo servidores, domínios, registros DNS, backups e snapshots.

Autenticação

Todas as solicitações de API exigem autenticação usando um token Bearer. Você pode gerar seu token de API nas configurações da sua conta em admin.vps.org/account/developers/.

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
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/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

Limitação de taxa

As requisições à API são limitadas a 300 requisições a cada 5 minutos por token de API. As informações sobre o limite de taxa estão incluídas nos cabeçalhos da resposta:

• X-RateLimit-Limit: Número máximo de solicitações permitidas
• X-RateLimit-Remaining: Número de solicitações restantes
• X-RateLimit-Reset: Registro de data e hora em que o limite de taxa é redefinido.

Tratamento de erros

A API utiliza códigos de status HTTP padrão para indicar sucesso ou falha:

Categorias da API

Consulte nossa documentação da API por categoria:

Precisar de ajuda?

Se você tiver dúvidas ou precisar de ajuda com a API, não hesite em entrar em contato:

• Solicitações de suporte: Abra um ticket de suporte
• E-mail: support@vps.org
• Documentação: Documentação completa