IPMI do servidor (VPN)

GET /cloud/servers/{id}/ipmi-vpn

Escopo do token: servers:read. Recurso: VPN da IPMI.

Se o servidor pode abrir uma sessão de VPN até a IPMI (unavailable diz por que não), as durações, a cota da conta, as portas liberadas e as sessões do servidor (as vivas e as 5 últimas encerradas). A senha da conta da IPMI vem enquanto a sessão está viva.

Exemplo de requisição

Os exemplos leem o token da variável de ambiente HALVER_API_TOKEN (um token sc_live_… criado em Desenvolvedores › Tokens de API). Nunca escreva o token no código.

curl "https://dash.halver.com.br/api/v1/cloud/servers/307d7f63-0f00-4d4b-bc28-839d359e13a3/ipmi-vpn" \
  -H "Authorization: Bearer $HALVER_API_TOKEN"

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
  "time"
)

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://dash.halver.com.br/api/v1/cloud/servers/307d7f63-0f00-4d4b-bc28-839d359e13a3/ipmi-vpn", nil)
  if err != nil {
    panic(err)
  }
  req.Header.Set("Authorization", "Bearer "+os.Getenv("HALVER_API_TOKEN"))
  client := &http.Client{Timeout: 30 * time.Second}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  out, err := io.ReadAll(resp.Body)
  if err != nil {
    panic(err)
  }
  fmt.Println(resp.Status)
  fmt.Println(string(out))
}

import os

import requests

resp = requests.get(
    "https://dash.halver.com.br/api/v1/cloud/servers/307d7f63-0f00-4d4b-bc28-839d359e13a3/ipmi-vpn",
    headers={
        "Authorization": f"Bearer {os.environ['HALVER_API_TOKEN']}",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Parâmetros

Parâmetros do caminho

id string (uuid) obrigatório
Exemplo: 307d7f63-0f00-4d4b-bc28-839d359e13a3.

Respostas

200

IPMI do servidor.

Campos da resposta

available boolean obrigatório
durations array de integer obrigatório
Durações possíveis, em minutos.
items array de object obrigatório
- activated_at string (date-time) obrigatório pode ser nulo
- apply_error string obrigatório
  Última resposta da IPMI ou do OPNsense a uma mudança que não passou (“” quando não há).
- bmc object obrigatório
  - address string obrigatório
    IP da IPMI, alcançável só pelo túnel.
  - password string obrigatório
    Só enquanto a sessão está viva e só para o cliente que opera os servidores (responsável); “” nos outros casos, inclusive para o usuário de consulta.
  - url string obrigatório
  - username string obrigatório
    Conta da IPMI criada para a sessão (papel Operator).
- close_reason string obrigatório
  Por que encerrou (ou está encerrando). operation = uma operação nossa (deploy, reinstalação, limpeza ou exclusão) começou no servidor; suspended = o servidor foi desligado por falta de pagamento. Um de: "" (vazio), ended, staff, expired, server_gone, failed, operation, suspended.
- closed_at string (date-time) obrigatório pode ser nulo
- created_at string (date-time) obrigatório
- duration_minutes integer obrigatório
- expires_at string (date-time) obrigatório
- hostname string obrigatório
- id string (uuid) obrigatório
- server_id string (uuid) obrigatório
- status string obrigatório
  opening = conta da IPMI e peer sendo criados; closing = peer, regras e conta sendo removidos. Um de: opening, active, closing, closed.
- wireguard object obrigatório
  - address string obrigatório
    Endereço do cliente no túnel (/32).
  - allowed_ips string obrigatório
    Só a IPMI do servidor (/32).
  - config string obrigatório
    Arquivo do wg-quick com <SUA_CHAVE_PRIVADA> no lugar da chave privada (“” até ativa).
  - endpoint string obrigatório
    host:porta do WireGuard do OPNsense.
  - keepalive integer obrigatório
  - public_key string obrigatório
    Chave pública do cliente.
  - server_public_key string obrigatório
    Chave pública do OPNsense (“” até a sessão ficar ativa).
ports array de object obrigatório
- port integer obrigatório
- protocol string obrigatório
  Um de: tcp, udp.
- use string obrigatório
quota object obrigatório
- limit integer obrigatório
- used integer obrigatório
unavailable string obrigatório
Um de: "" (vazio), server_busy, region_without_vpn, machine_without_bmc, suspended.

{
  "available": true,
  "durations": [
    0
  ],
  "items": [
    {
      "activated_at": null,
      "apply_error": "",
      "bmc": {
        "address": "198.51.100.20",
        "password": "",
        "url": "",
        "username": "sc-7f3a"
      },
      "close_reason": "ended",
      "closed_at": null,
      "created_at": "2026-10-20T18:00:00Z",
      "duration_minutes": 60,
      "expires_at": "2026-10-20T18:00:00Z",
      "hostname": "web-01",
      "id": "f6ba3404-eb7b-4ebc-8d6b-7483c6c094b0",
      "server_id": "307d7f63-0f00-4d4b-bc28-839d359e13a3",
      "status": "opening",
      "wireguard": {
        "address": "198.51.100.20",
        "allowed_ips": "10.250.0.0/24",
        "config": "",
        "endpoint": "198.51.100.1:51820",
        "keepalive": 25,
        "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIExemploDeChavePublicaNaoUseEm0123456789 ana@notebook",
        "server_public_key": ""
      }
    }
  ],
  "ports": [
    {
      "port": 51820,
      "protocol": "tcp",
      "use": ""
    }
  ],
  "quota": {
    "limit": 50,
    "used": 1
  },
  "unavailable": "server_busy"
}

Erros

Todo erro vem como application/problem+json (RFC 9457), com um code estável, a mensagem em português em detail, o motivo de cada campo em errors (nos erros de validação) e o request_id, que você informa ao suporte. Veja a lista completa de códigos.

Status	Quando	Códigos
400	Requisição inválida (JSON malformado, campo desconhecido, parâmetro inválido ou falha de validação).	`validation_failed`
401	Não autenticado (token ausente, inválido ou expirado; credenciais inválidas).	`auth.unauthorized`
403	Autenticado, mas sem permissão para a área ou a operação.	`api_token.insufficient_scope`
404	Recurso não encontrado (ou fora do escopo do usuário).	`server.not_found`

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "o token não tem o escopo servers:read; crie um token com esse escopo em Desenvolvedores › Tokens de API",
  "code": "api_token.insufficient_scope",
  "request_id": "6f1c0b2a9e4d7c3b5a8f0e1d"
}