Chaves SSH

Cadastre chaves SSH na conta e vincule-as às suas VPS; a chave é aplicada na VM automaticamente.

4 min de leitura Atualizado em 25 de maio de 2026

O que você vai conseguir

Cadastre chaves SSH na conta e vincule-as às suas VPS.

Antes de começar

Autenticação via token Bearer no header Authorization.
As rotas operam apenas sobre os recursos do cliente autenticado.

Gerencie as chaves SSH da sua conta e vincule-as às suas VPS. As chaves são reutilizáveis: você cadastra uma vez e vincula a quantas VPS quiser. Ao vincular/desvincular, a chave é aplicada/removida na VM automaticamente (via guest agent) — por isso essas operações respondem 202.

Endpoints

GET /api/ssh-keys

Listar chaves

Lista as chaves SSH cadastradas na sua conta.

{
    "data": [
        {
            "id": "9b1f4c2a-...",
            "name": "Notebook pessoal",
            "fingerprint": "SHA256:Sbq1zJIK...",
            "type": "ed25519",
            "is_active": true,
            "last_used_at": null,
            "created_at": "2026-06-29T12:00:00+00:00"
        }
    ]
}

POST /api/ssh-keys

Cadastrar chave

Cadastra uma nova chave SSH na conta. O fingerprint e o tipo são detectados automaticamente.

Corpo (JSON)

Campo	Tipo	Descrição
`name` obrigatório	`string`	Nome para identificar a chave.
`public_key` obrigatório	`string`	Chave pública (ssh-rsa, ssh-ed25519, ecdsa-sha2-* ou ssh-dss).

Chave já cadastrada (mesmo fingerprint) retorna 422. Responde 201 em caso de sucesso.

DELETE /api/ssh-keys/{id}

Remover chave

Remove a chave da conta. Se estiver vinculada a VPS, ela é desvinculada e removida das VMs automaticamente.

Parâmetros de rota

Campo	Tipo	Descrição
`id` obrigatório	`uuid`	ID da chave (precisa ser da sua conta).

GET /api/vps/{id}/ssh-keys

Listar chaves da VPS

Lista as chaves SSH atualmente vinculadas à VPS.

Parâmetros de rota

Campo	Tipo	Descrição
`id` obrigatório	`uuid`	ID da VPS.

POST /api/vps/{id}/ssh-keys

Vincular chave existente

Vincula uma chave já cadastrada na conta à VPS. A chave é aplicada na VM em seguida (resposta 202).

Parâmetros de rota

Campo	Tipo	Descrição
`id` obrigatório	`uuid`	ID da VPS.

Corpo (JSON)

Campo	Tipo	Descrição
`ssh_key_id` obrigatório	`uuid`	ID de uma chave da sua conta (ver Listar chaves).

Chave já vinculada retorna 409.

DELETE /api/vps/{id}/ssh-keys/{keyId}

Desvincular chave

Desvincula a chave da VPS e a remove da VM (resposta 202). A chave permanece na conta.

Parâmetros de rota

Campo	Tipo	Descrição
`id` obrigatório	`uuid`	ID da VPS.
`keyId` obrigatório	`uuid`	ID da chave vinculada.

O que você vai conseguir

Antes de começar

Endpoints

Listar chaves

Cadastrar chave

Remover chave

Listar chaves da VPS

Vincular chave existente

Desvincular chave

A sua privacidade é muito importante para nós