SSH Keys API

Overview

The SSH Keys API stores SSH public/private key pairs, generates new keys with ssh-keygen, imports existing private keys to derive their public keys, and returns fingerprints for key identification. Keys are scoped to the authenticated user.

Base URL

https://api.allternit.com/api/v1/ssh-keys

All endpoints require a valid Bearer token in the Authorization header. See Authentication for details.

Endpoints

Method	Path	Description
GET	`/ssh-keys`	List SSH keys.
POST	`/ssh-keys`	Store an SSH key.
POST	`/ssh-keys/generate`	Generate a new SSH key pair.
POST	`/ssh-keys/import`	Import a private key and derive its public key.
GET	`/ssh-keys/:id`	Get an SSH key.
PUT	`/ssh-keys/:id`	Update an SSH key.
DELETE	`/ssh-keys/:id`	Delete an SSH key.

List keys

GET /api/v1/ssh-keys

Response:

[
  {
    "id": "key_2f8a9c4e5d3b",
    "name": "Laptop key",
    "fingerprint": "9e107d9d372bb6826bd81d3542a419d6",
    "public_key": "ssh-ed25519 AAAAC3NzaC1...",
    "key_type": "ed25519",
    "bits": 256,
    "last_used_at": null,
    "created_at": "2026-08-13T10:00:00Z",
    "updated_at": "2026-08-13T10:00:00Z"
  }
]

Store key

POST /api/v1/ssh-keys

Request body:

{
  "name": "Laptop key",
  "public_key": "ssh-ed25519 AAAAC3NzaC1...",
  "private_key": null,
  "passphrase": null,
  "key_type": "ed25519",
  "bits": 256
}

Response:

{
  "id": "key_2f8a9c4e5d3b",
  "name": "Laptop key",
  "fingerprint": "9e107d9d372bb6826bd81d3542a419d6",
  "public_key": "ssh-ed25519 AAAAC3NzaC1...",
  "key_type": "ed25519",
  "bits": 256
}

Generate key

POST /api/v1/ssh-keys/generate

Request body:

{
  "name": "CI deploy key",
  "type": "ed25519",
  "bits": 256
}

Response:

{
  "id": "key_7e1a2b3c",
  "name": "CI deploy key",
  "public_key": "ssh-ed25519 AAAAC3NzaC1...",
  "private_key": "-----BEGIN OPENSSH PRIVATE KEY-----\n...",
  "fingerprint": "9e107d9d372bb6826bd81d3542a419d6"
}

Supported key types: ed25519, rsa, ecdsa. RSA defaults to 4096 bits; ed25519 and ecdsa are always 256 bits. The fingerprint is the lowercase hex MD5 digest of the trimmed public key text, not the colon-separated ssh-keygen -l form.

Import key

POST /api/v1/ssh-keys/import

Request body:

{
  "name": "Imported key",
  "private_key": "-----BEGIN OPENSSH PRIVATE KEY-----\n...",
  "passphrase": null
}

Response:

{
  "id": "key_5e6f7a8b",
  "name": "Imported key",
  "fingerprint": "9e107d9d372bb6826bd81d3542a419d6",
  "public_key": "ssh-ed25519 AAAAC3NzaC1...",
  "created_at": "2026-08-13T10:00:00Z"
}

Error codes

Status	Code	Description
200	—	Success.
201	—	Created successfully.
400	`Name is required`	Missing key name.
400	`private_key is required`	Import request missing private key.
400	`Failed to derive public key from private key`	Import failed.
401	—	Missing or invalid authentication.
404	`SSH key not found`	Key does not exist.
500	`internal error` / `ssh-keygen failed`	Unexpected server error, or key generation failed.

Platform API

Legal

Overview

Agency API (Preview)

LLM Gateway

Agents & Runtime

Work Queue & Deployments

Files, Webhooks & Sandbox

Tools & Connectors

Collaboration & Workflows

Infrastructure & Platform

Canvases

Onboarding

A Labs

Playground

Users & Profiles

Overview

Base URL

Endpoints

List keys

Store key

Generate key

Import key

Error codes

​Overview

​Base URL

​Endpoints

​List keys

​Store key

​Generate key

​Import key

​Error codes

​Related links

Overview

Base URL

Endpoints

List keys

Store key

Generate key

Import key

Error codes

Related links