Documentação da API 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);

Cada token carrega suas próprias permissões, como servidores:list ou dns:*. Um pedido que necessita de uma permissão o token não tem sido recusado com 403 e um campo de permissão exigido que nomeia a permissão faltante. Referência de Permissões

Limitação de taxa

Os pedidos autenticados são limitados a 1.000 por hora por conta. Os pedidos não autenticados são limitados a 100 por hora por endereço IP. Um pedido sobre o limite recebe 429 com um cabeçalho de Voltar-Após que dá o número de segundos para esperar. Nenhum header limite de taxa é enviado em respostas bem sucedidas.

Paginação

Os endpoints listados retornam um objeto com contagem, seguinte, anterior e resultados, 25 itens por página. Passar página para mover entre páginas, ou seguir a seguinte URL até que seja nulo. A lista de servidores também aceita página_tamanho, até 100.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

Tratamento de erros

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

Os corpos de erro são JSON. A maioria tem um campo de detalhes ou um campo de erro, às vezes com uma mensagem; erros de validação listam os problemas por nome de campo.

Categorias da API

Consulte nossa documentação da API por categoria:

Mais pontos finais

A API também tem endpoints para implantações de aplicativos (/api/v1/deploy-configs/ e /api/v1/deploiments/). Eles ainda não são descritos nestas páginas; as listas de referência interativas cada endpoint, gerado a partir da API ao vivo.

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: hello@vps.org
• Documentação: Documentação completa