SSH

SSH Host Keys API

SSH server host key management

OpenAPI Specification

ssh-host-keys-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: SSH Key Management Authorized Keys Host Keys API
  description: A REST API for managing SSH keys, certificates, and access policies in infrastructure environments. Provides endpoints for key generation, certificate signing, authorized keys management, and host key verification. This represents common SSH management capabilities available via OpenSSH tooling and SSH certificate authority implementations.
  version: '1.0'
  contact:
    name: OpenSSH Project
    url: https://www.openssh.com/
  license:
    name: BSD License
    url: https://www.openssh.com/portable.html
servers:
- url: https://api.openssh.example.com/v1
  description: SSH Management API
security:
- BearerAuth: []
tags:
- name: Host Keys
  description: SSH server host key management
paths:
  /host-keys/{hostname}:
    get:
      operationId: getHostKeys
      summary: Get Host Keys
      description: Returns the SSH host keys for a specific server.
      tags:
      - Host Keys
      parameters:
      - name: hostname
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Host keys
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostKeyResponse'
components:
  schemas:
    HostKeyResponse:
      type: object
      properties:
        hostname:
          type: string
        keys:
          type: array
          items:
            $ref: '#/components/schemas/KnownHost'
    KnownHost:
      type: object
      properties:
        id:
          type: string
        hostname:
          type: string
        keyType:
          type: string
        publicKey:
          type: string
        fingerprint:
          type: string
        addedAt:
          type: string
          format: date-time
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT