API REST v1

Documentação de Integração

Automatize a aquisição, o provisionamento imediato e o controle operacional de seus servidores VPS com infraestrutura global através de nossa API RESTful.

# Autenticação

Todas as requisições enviadas para a nossa API devem incluir o token de segurança no cabeçalho HTTP Authorization utilizando o esquema Bearer.

Aviso Importante: Para provisionar servidores via API, é essencial possuir uma forma de pagamento (cartão de crédito) vinculada à sua conta. A cobrança do ciclo mensal é processada de forma automática no momento de conclusão da chamada de criação.

Endpoints Rápidos

Método	Rota	Ação
GET	/v1/vps	Listar Instâncias
GET	/v1/vps/{id}	Consultar Status
POST	/v1/vps	Comprar VPS
POST	/v1/vps/{id}/action	Controle de Energia
POST	/v1/vps/{id}/upgrade	Solicitar Upgrade de vCPU
POST	/v1/vps/{id}/cancel	Terminar / Cancelar
POST	/v1/vps/move-additional-ip	Mover IP adicional para outra VPS

Diretrizes de Funcionamento

• Tempo de Provisionamento: Enquanto a VPS está sendo instalada, o campo ip_v4 no retorno da consulta pode constar como null. Consulte novamente o status após cerca de 30 segundos.
• Regra de Cancelamento: Chamadas ao endpoint de cancelamento encerram e deletam a VPS imediatamente do cluster de virtualização. O cálculo do consumo é proporcional e o valor residual restante é debitado ou creditado conforme sua fatura.

Requisição Básica (cURL)

HTTP Headers

curl -H "Authorization: Bearer SEU_TOKEN" \
     -H "Accept: application/json" \
     https://api.coelhovps.com.br/v1/vps

Criar / Comprar VPS

POST

Informe a quantidade de vCPUs virtuais e a distribuição desejada. O sistema resolverá o plano automaticamente.

curl -X POST \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "vcpu": 4,
       "sistema_id": "ubuntu-22-04-lts"
     }' \
     https://api.coelhovps.com.br/v1/vps

Gerenciamento de Energia

POST

Os valores suportados para o parâmetro action são: start, stop e restart.

curl -X POST \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "action": "stop"
     }' \
     https://api.coelhovps.com.br/v1/vps/203430758/action

Deletar / Cancelar

DELETE / POST

Remove a máquina virtual permanentemente. Esta ação não pode ser desfeita.

curl -X POST \
     -H "Authorization: Bearer SEU_TOKEN" \
     https://api.coelhovps.com.br/v1/vps/203430758/cancel

Mover IP adicional para outra VPS

POST

Move o IP adicional para a VPS vinculada ao contrato informado. A resposta pública omite detalhes internos do provedor.

curl -X POST \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "ip": "169.58.190.73",
       "contrato_id": 155
     }' \
     https://api.coelhovps.com.br/v1/vps/move-additional-ip

Exemplo de resposta

{
  "message": "IP adicional movido com sucesso.",
  "data": {
    "ip": "169.58.190.73",
    "contrato_id": 155,
    "status": "moved"
  }
}

Solicitar Upgrade de VPS

POST

Cria um pedido de upgrade de vCPU para sua VPS. O pedido precisa ser aprovado pela equipe.

curl -X POST \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"vcpu_up": 8}' \
     https://api.coelhovps.com.br/v1/vps/203430758/upgrade

Exemplo de resposta

{
  "message": "Pedido de upgrade criado com sucesso. Aguarde aprovação.",
  "data": {
    "upgrade_request_id": 47,
    "contract_id": 155,
    "requested_vcpu": "8",
    "requested_plan_value": 249.90,
    "charge_amount": 219.90,
    "discount_amount": 30.00,
    "status": "pendente"
  }
}