VPS.org API

REST API Documentation

VPS.org API Documentation

Documentação completa da API REST para gerenciamento de servidores VPS, domínios, DNS, backups e muito mais.

URL base https://admin.vps.org/api/v1
Autenticação Token ao portador
Version v1.0
Format JSON

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
Python
JavaScript
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:

Tratamento de erros

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

Código de status Description
200 Sucesso - Solicitação concluída com êxito
201 Criado - Recurso criado com sucesso
400 Solicitação inválida - Parâmetros inválidos ou solicitação malformada
401 Não autorizado - Token de autenticação inválido ou ausente
403 Proibido - Permissões insuficientes
404 Não encontrado - O recurso não existe.
429 Muitas solicitações - Limite de requisições excedido
500 Erro interno do servidor - Algo deu errado em nossa área.

Categorias da API

Consulte nossa documentação da API por categoria:

API de servidores 9 pontos finais

Crie, gerencie e controle servidores VPS. Inclui gerenciamento de energia, redimensionamento, reinstalação e recuperação de informações do servidor.

Ver documentação
API de backups 3 pontos finais

Gerencie backups automatizados e manuais para seus servidores. Liste, crie, restaure e exclua backups do servidor.

Ver documentação
API de Snapshots 4 pontos finais

Crie e gerencie snapshots de servidor para pontos de restauração rápidos. Perfeito para testes e reversões rápidas.

Ver documentação
API de Planos 2 pontos finais

Consulte os planos VPS disponíveis e as informações de preços. Obtenha detalhes sobre recursos, preços e disponibilidade.

Ver documentação
API de Sistemas Operacionais 2 pontos finais

Lista de sistemas operacionais e imagens disponíveis para implantação em servidores. Inclui Ubuntu, Debian, CentOS e outros.

Ver documentação
Domains API 6 pontos finais

Pesquise, verifique a disponibilidade, registre e gerencie nomes de domínio. Gerenciamento completo do ciclo de vida do domínio por meio da API.

Ver documentação
DNS API 4 pontos finais

Gerencie zonas e registros DNS programaticamente. Crie, atualize e exclua registros dos tipos A, AAAA, CNAME, MX, TXT e outros.

Ver documentação
API de Localizações 1 ponto final

Liste os locais de data center disponíveis para implantação de servidores. Escolha entre várias regiões ao redor do mundo.

Ver documentação
Account 1 endpoint

Retrieve account profile and API token information. Identify which account a token belongs to and check its permissions.

Ver documentação

Precisar de ajuda?

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