HELPER VPS

API

JSON sobre HTTPS. Envie sua chave API no cabeçalho Authorization. Até 300 requisições por minuto.

Endereço base

https://helpervps.com/api/v1

Autenticação

Cabeçalho Authorization: Bearer YOUR_API_KEY. Crie a chave na página Chave API depois da sua primeira recarga.

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /catalog

Tamanhos, locais e sistemas que você pode escolher.

Exemplo de resposta

{
  "plans": [ { "code": "s2", "vcpu": 1, "ram_mb": 2048, "disk_gb": 50, "monthly": "12.00" } ],
  "locations": [ "frankfurt", "singapore" ],
  "images": [ "ubuntu-24-04", "debian-12" ]
}

GET /servers

Seus servidores.

Exemplo de resposta

[
  { "id": 41, "label": "web-1", "state": "running", "ipv4": "192.0.2.15", "paid_until": "2026-11-14T09:00:00Z" }
]

POST /servers {"plan":"s2","location":"frankfurt","image":"ubuntu-24-04","label":"web-1"}

Cria um servidor e paga o primeiro mês com seu saldo. A senha de root vem na resposta uma única vez.

Exemplo de resposta

{
  "id": 41,
  "state": "creating",
  "root_password": "..."
}

POST /servers/{id}/start (stop, reboot)

Ações de energia.

Exemplo de resposta

{
  "id": 41,
  "state": "running"
}

POST /servers/{id}/renew

Paga mais um mês agora.

Exemplo de resposta

{
  "id": 41,
  "paid_until": "2026-12-14T09:00:00Z"
}

DELETE /servers/{id}

Exclui o servidor. O restante do mês não é reembolsado.

Exemplo de resposta

{
  "id": 41,
  "state": "deleted"
}

Erros

Os erros retornam um status diferente de 2xx e um corpo JSON com um código de erro.

unauthorizedChave API ausente ou incorreta
not_allowedA API é liberada depois da sua primeira recarga
bad_requestUm campo está ausente ou incorreto
not_enough_balanceRecarregue primeiro
limitServidores demais na conta
not_createdNão foi possível criar o servidor; o mês voltou para seu saldo
checkingO fornecedor não confirmou; concluímos o servidor ou devolvemos o mês
not_foundEsse servidor não existe na sua conta
wrong_stateA ação não combina com o estado atual do servidor
rate_limitedRequisições demais em um minuto