HELPER VPS

API de VPS: automatize servidores na nuvem com JSON REST

API de servidores na nuvem para gerenciar pelo código, da criação à exclusão

  • JSON REST API
  • Autenticação por chave de API (Bearer)
  • 300 requisições por minuto

Uma API de VPS é uma forma programática de fazer o trabalho que você faria no painel de controle, como criar, iniciar, parar e excluir servidores, com requisições HTTP. A API de servidores na nuvem da HELPER VPS é gratuita para todos os membros; após o primeiro pagamento, crie uma chave de API e conecte-se imediatamente.

  • REST API

    Todos os clientes

    Grátis

    Cobrança mensal

    • JSON REST
    • Chave de API (Bearer)
    • 300 por minuto
    • Grátis
    Começar

Para ver na hora exemplos de requisição e formatos de resposta Documentação da API

O que posso automatizar com a API de VPS?

A API de VPS mostra sua força quando você cria e exclui servidores com frequência ou gerencia vários servidores de uma vez. Reunimos as quatro automações mais comuns.

Painel ou API de VPS: quando usar cada um?

O painel de controle e a API funcionam com a mesma conta e os mesmos servidores. Para gerenciar um ou dois servidores manualmente, o painel de controle é conveniente; para trabalhos repetitivos ou muitos servidores, a API é mais rápida.

Painel

Gestão clicando na tela

Indicado para

  • Quando cria um servidor pela primeira vez
  • Quando gerencia você mesmo um ou dois servidores
  • Reinstalação de sistema operacional e cadastro de chaves SSH
  • Quando precisa ver de novo a senha de root

VPS API

Gestão por requisições no código

Indicado para

  • Ambientes de teste em que cria e exclui servidores com frequência
  • Pipelines de deploy e automação com scripts
  • Quando lê de uma vez o estado de vários servidores
  • Quando conecta ao seu próprio painel ou bot

Como conecto a API de servidores na nuvem?

São três passos. Primeiro, faça seu primeiro pagamento e, uma vez confirmado, crie uma chave na página de chaves de API. Em seguida, coloque a chave no cabeçalho Authorization de cada requisição usando o esquema Bearer. Por fim, envie requisições para o caminho desejado após o endereço base https://helpervps.com/api/v1, e os resultados retornam em JSON.

Para começar, convém chamar GET /catalog. Voltam de uma vez os tipos e tamanhos de servidor disponíveis, os códigos de região, os códigos de sistemas operacionais e apps em um clique e os preços de backup automático, disco adicional e proteção DDoS. Basta colocar os códigos plan, location e image recebidos aqui na requisição de criação de servidor.

Para criar um servidor, envie os valores plan, location, image e label como JSON para POST /servers. Você também pode incluir o ID de uma chave SSH que adicionou e as opções backups, extra_disk_gb e ddos_protection. Você paga pelo período escolhido antecipadamente, e a resposta contém o ID do servidor, status e senha root, então salve-os imediatamente em um local seguro.

Que tarefas posso fazer com a API de VPS?

A API de VPS trata o ciclo de vida do servidor do início ao fim. Leia a lista de produtos com GET /catalog, crie servidores com POST /servers, leia a lista dos seus servidores com GET /servers e os dados de um servidor com GET /servers/{id}. A resposta traz nome do servidor, estado, endereços IPv4 e IPv6, mensalidade, opções escolhidas e próxima data de cobrança.

A energia é controlada com as requisições POST /servers/{id}/start, stop e reboot, para ligar, desligar e reiniciar. POST /servers/{id}/renew paga agora um mês, sem esperar a data de cobrança, e renova na hora, e DELETE /servers/{id} exclui o servidor. Se a requisição não combina com o estado atual do servidor, você recebe o código wrong_state, o que facilita ao script decidir o próximo passo.

Os erros voltam em JSON com o código de estado e o valor error. Os motivos vêm separados em códigos, como unauthorized se a chave não confere, not_enough_balance se falta saldo, limit se a conta chegou ao limite de servidores e rate_limited se há requisições demais, o que facilita tratar cada situação no programa. A lista completa e exemplos de resposta estão na documentação da API.

Quanto custa a API de VPS?

A API de VPS é gratuita para todos os membros. Servidores e opções criados com a API são pagos pelos mesmos preços dos servidores criados no painel de controle.

HELPER VPS em números

Escolha entre 40 regiões, 12 sistemas operacionais e 10 aplicativos de um clique em uma conta e pague imediatamente. Os números abaixo são baseados no que está à venda agora.

Ferramentas de automação para usar com a API de VPS

Qualquer ferramenta que envie requisições HTTP se conecta à API de VPS. De uma linha de curl a scripts em Python e Node.js e pipelines de deploy, tudo funciona do mesmo jeito.

  • Terraform
  • Python
  • Node.js
  • GitLab CI
  • Docker

Por que escolher a API da HELPER VPS

Perguntas frequentes sobre a API de VPS

Respostas sobre conexão, autenticação e limite de requisições da API de VPS

A API de VPS é grátis?

Sim, a API de VPS é gratuita para todos os membros. Emitir chaves de API e fazer requisições é gratuito, e servidores e opções criados com a API são pagos pelos mesmos preços dos criados no painel de controle. Qualquer membro que tenha feito o primeiro pagamento pode criar uma chave imediatamente na página de chaves de API.

Onde crio a chave de API?

Após fazer seu primeiro pagamento, a página de chaves de API (/api-key) abre e você cria as chaves lá. Coloque a chave no cabeçalho Authorization de cada requisição usando o esquema Bearer. A chave desbloqueia toda a sua conta, então não a comprometa em repositórios de código; mantenha-a em variáveis de ambiente ou em um cofre de segredos.

Que tarefas posso fazer pela API?

Você pode ler a lista de produtos (GET /catalog), ler a lista de servidores e os dados de um servidor (GET /servers, GET /servers/{id}), criar servidores (POST /servers), ligar, desligar e reiniciar (start, stop, reboot), renovar um mês (renew) e excluir (DELETE /servers/{id}). Exemplos de requisição e formatos de resposta estão na documentação da API.

Qual é o limite de requisições?

Com uma chave você faz até 300 requisições por minuto. Passando do limite, volta o código de estado 429 com o erro rate_limited, então basta o script esperar um pouco e reenviar. Automações do dia a dia, como conferir a lista de servidores e gerenciar a energia, funcionam com folga dentro desse limite. Não há cobrança pelo número de requisições.

Como é cobrado um servidor criado pela API?

Quando uma requisição POST /servers é bem-sucedida, o pagamento pelo período de cobrança escolhido é processado e o servidor é criado. O pagamento por um servidor que falha ao ser criado é devolvido ao crédito da sua conta.

Como recebo a senha de root pela API?

A resposta da requisição de criação traz uma vez o valor root_password. Guarde-o em um lugar seguro assim que receber a resposta. No painel você também pode vê-la de novo por 7 dias, e enviando junto o número da chave SSH, você entra direto com a chave, sem senha. Com o valor ipv4 da resposta você já começa o acesso SSH, ótimo para ligar a scripts de deploy.

Posso colocar chaves SSH pela API?

Sim, colocando no valor ssh_key_id da requisição de criação o número de uma chave SSH cadastrada, essa chave vai para o novo servidor. Cadastre a chave uma vez na tela de chaves SSH do painel; a impressão digital aparece no mesmo formato do ssh-keygen, para você reconhecer a chave na hora. Defina o número da chave uma vez e reutilize.

Com que linguagens ou ferramentas posso usar?

Qualquer linguagem ou ferramenta que envie requisições HTTP serve. Teste na hora com curl e chame com o mesmo endereço e cabeçalho a partir do requests do Python, do fetch do Node.js, das etapas de script do GitLab CI ou das requisições HTTP do Terraform. Todas as respostas são JSON, fáceis de ler.

Como sei que houve um erro?

Os erros voltam em JSON com um código de estado que não é 2xx e o valor error. Os motivos vêm separados, como unauthorized se a chave está errada, bad_request se falta um valor, not_enough_balance se falta saldo e wrong_state se a requisição não combina com o estado do servidor, para tratar cada situação no programa.

Servidores criados pela API aparecem no painel?

Sim, a API e o painel tratam a mesma conta e os mesmos servidores. Servidores criados pela API aparecem tal como estão na lista do painel, onde você pode reinstalar o sistema operacional ou ver a senha. O limite de 10 servidores por conta também vale para as duas formas. Mesmo misturando trabalho manual e pelo código, estado e datas de cobrança aparecem sempre iguais.

Guias da API de VPS

Guias úteis para ler ao conectar a API pela primeira vez

A API de VPS é gratuita para todos os membros, e você pode criar uma chave de API após fazer o primeiro pagamento. Servidores e opções criados com a API são pagos pelos mesmos preços da lista de preços e renovam automaticamente pelo mesmo valor em cada data de cobrança.

Limite de requisições: 300 por minuto por chave de API | 10 servidores por conta | Se o pagamento falhar: servidor suspenso, depois excluído 3 dias depois | O tempo restante em servidores excluídos não é reembolsado. Reembolsos vão para o crédito da sua conta.