Detalha uma chave SSH

GET /cloud/ssh-keys/{id}

Escopo do token: ssh_keys:read. Recurso: Chaves SSH.

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

curl "https://dash.halver.com.br/api/v1/cloud/ssh-keys/f14f67d8-9ae9-4217-991b-854a52150ae7" \
  -H "Authorization: Bearer $HALVER_API_TOKEN"

Go

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/ssh-keys/f14f67d8-9ae9-4217-991b-854a52150ae7", 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))
}

Python

import os

import requests

resp = requests.get(
    "https://dash.halver.com.br/api/v1/cloud/ssh-keys/f14f67d8-9ae9-4217-991b-854a52150ae7",
    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: f14f67d8-9ae9-4217-991b-854a52150ae7.

Respostas

200

Chave.

Campos da resposta

• created_at string (date-time) obrigatório
• fingerprint string obrigatório
• id string (uuid) obrigatório
• name string obrigatório
• public_key string obrigatório

Exemplo de resposta

{
  "created_at": "2026-10-20T18:00:00Z",
  "fingerprint": "SHA256:k3Q0Exemplo8bW1tq6Nf5d7xJ0r2YpZsA9cVvLmEx1gU",
  "id": "f14f67d8-9ae9-4217-991b-854a52150ae7",
  "name": "notebook da Ana",
  "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIExemploDeChavePublicaNaoUseEm0123456789 ana@notebook"
}

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).	ssh_key.not_found

Exemplo de erro

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