Referência da API

Todas as 54 operações que um token de API pode chamar, geradas a cada publicação desta documentação a partir da referência OpenAPI que os testes da plataforma conferem contra o servidor. Endereço base: https://dash.halver.com.br/api/v1.

Conta

O usuário dono do token, o papel dele na conta e as permissões desse papel. Responde a qualquer token, sem escopo: use para conferir se um token vale.

• GET/meUsuário atual e permissõesqualquer token

Catálogo e cupons

O que dá para contratar agora: locais, planos com preço e estoque por local e sistemas operacionais. Os ids daqui vão no deploy de um servidor.

• GET/cloud/catalogO que dá para contratar agoraservers:read
• POST/cloud/coupons/checkConfere um cupom no checkout do deployservers:write

Servidores

Contratar (deploy), listar, ligar e desligar, escolher o próximo boot, reinstalar, apagar o sistema e cancelar servidores bare metal. Deploy, reinstalação, limpeza e remoção continuam em segundo plano: acompanhe pela operação.

• GET/cloud/serversServidores da contaservers:read
• POST/cloud/serversFaz o deploy de um servidorservers:write
• GET/cloud/servers/{id}Detalha um servidorservers:read
• PATCH/cloud/servers/{id}Altera hostname, tags, descrição e as referências do revendedorservers:write
• DELETE/cloud/servers/{id}Cancela a assinatura do servidorservers:delete
• POST/cloud/servers/{id}/boot-deviceDispositivo do próximo bootservers:write
• DELETE/cloud/servers/{id}/cancellationDesfaz o cancelamento agendadoservers:write
• POST/cloud/servers/{id}/powerLiga, desliga ou reiniciaservers:write
• POST/cloud/servers/{id}/reinstallReinstala um servidorservers:delete
• POST/cloud/servers/{id}/wipeApaga o sistema e os dados, mantendo a máquinaservers:delete

Operações

O contrato de espera da API: cada deploy, reinstalação, limpeza e remoção vira uma operação que você consulta até succeeded ou failed.

• GET/cloud/operationsOperações dos servidores da contaservers:read
• GET/cloud/operations/{id}Detalha uma operaçãoservers:read

Console serial

A tela de texto e o teclado do servidor pela IPMI (Serial over LAN), mesmo sem rede no sistema. Abrir, ler, digitar e encerrar pedem o escopo servers:console.

• GET/cloud/servers/{id}/consoleConsole serial do servidorservers:read
• POST/cloud/servers/{id}/consoleAbre o console serialservers:console
• GET/cloud/servers/{id}/console/{sessionID}Detalha uma sessão do console serialservers:read
• DELETE/cloud/servers/{id}/console/{sessionID}Encerra o console serialservers:console
• POST/cloud/servers/{id}/console/{sessionID}/inputDigita no console serialservers:console
• GET/cloud/servers/{id}/console/{sessionID}/outputSaída bruta do console serialservers:console
• GET/cloud/servers/{id}/console/{sessionID}/screenTela do console serialservers:console
• GET/cloud/servers/{id}/console/{sessionID}/transcriptGravação da sessão do console serialservers:console

VPN da IPMI

Uma sessão de VPN (WireGuard) até a IPMI do servidor, com usuário e senha temporários. Abrir e encerrar pedem o escopo servers:console.

• GET/cloud/servers/{id}/ipmi-vpnIPMI do servidor (VPN)servers:read
• POST/cloud/servers/{id}/ipmi-vpnAbre uma sessão de VPN até a IPMIservers:console
• GET/cloud/servers/{id}/ipmi-vpn/{sessionID}Detalha uma sessão de VPN até a IPMIservers:read
• DELETE/cloud/servers/{id}/ipmi-vpn/{sessionID}Encerra a sessão antes do fimservers:console

Chaves SSH

As chaves públicas que o deploy e a reinstalação instalam nos servidores.

• GET/cloud/ssh-keysChaves SSH da contassh_keys:read
• POST/cloud/ssh-keysAdiciona uma chave SSHssh_keys:write
• GET/cloud/ssh-keys/{id}Detalha uma chave SSHssh_keys:read
• PATCH/cloud/ssh-keys/{id}Renomeia uma chave SSHssh_keys:write
• DELETE/cloud/ssh-keys/{id}Remove uma chave SSHssh_keys:write

Rede da conta

As regiões da conta, o que cada uma oferece agora (IP elástico e preço, rede privada) e as cotas da conta.

• GET/cloud/networkVisão da rede da contanetworks:read

Redes privadas

Redes privadas (VLAN) entre os servidores da conta numa região: criar, colocar e tirar servidores e apagar.

• GET/cloud/network/private-networksRedes privadasnetworks:read
• POST/cloud/network/private-networksCria uma rede privadanetworks:write
• GET/cloud/network/private-networks/{id}Detalha uma rede privadanetworks:read
• PUT/cloud/network/private-networks/{id}Altera a descriçãonetworks:write
• DELETE/cloud/network/private-networks/{id}Apaga a rede privadanetworks:write
• POST/cloud/network/private-networks/{id}/serversColoca um servidor na redenetworks:write
• DELETE/cloud/network/private-networks/{id}/servers/{serverID}Tira um servidor da redenetworks:write

IPs elásticos

Endereços IPv4 da conta que você move entre servidores da mesma região. Contratar um IP com preço gera cobrança no cartão salvo.

• GET/cloud/network/elastic-ipsIPs elásticosips:read
• POST/cloud/network/elastic-ipsCria um IP elásticoips:write
• GET/cloud/network/elastic-ips/{id}Detalha um IP elásticoips:read
• DELETE/cloud/network/elastic-ips/{id}Libera o IP elásticoips:write
• POST/cloud/network/elastic-ips/{id}/assignAtribui ou move o IP elásticoips:write

Faturas

As faturas da conta, com as cobranças, e o comprovante de uma fatura paga. Só leitura.

• GET/portal/invoicesLista as faturas do clienteinvoices:read
• GET/portal/invoices/{id}Detalha uma fatura do cliente com cobrançasinvoices:read
• GET/portal/invoices/{id}/receiptComprovante de pagamento de uma fatura do clienteinvoices:read

Cartões

Os cartões salvos na conta (bandeira, final e validade). Cadastrar cartão e pagar faturas só pelo painel.

• GET/portal/payment-methodsLista os cartões salvospayment_methods:read

Chamados

Abrir, acompanhar, responder e resolver chamados de suporte.

• GET/portal/support/ticketsLista os chamados da contasupport:read
• POST/portal/support/ticketsAbre um chamadosupport:write
• GET/portal/support/tickets/{id}Mostra um chamado com a conversasupport:read
• POST/portal/support/tickets/{id}/messagesResponde no chamadosupport:write
• POST/portal/support/tickets/{id}/resolveMarca o chamado como resolvidosupport:write