SSH

Prerequisites

Feedback
Username - The username with the required permissions to connect (e.g., root)
Feedback
Host - The hostname or IP address of the machine
Feedback
Password/Private Key - The password or SSH private key for the user

Setup SSH Connection in Hanzo KMS

Navigate to the App Connections tab in your Organization Settings.

Click the + Add Connection button and select SSH Connection from the available options.

Complete the SSH Connection form by entering:

• A descriptive name for the connection
• An optional description for future reference
• The SSH host (hostname or IP address)
• The SSH port (default is 22)
• The username for your machine
• The SSH password for the user

Complete the SSH Connection form by entering:

• A descriptive name for the connection
• An optional description for future reference
• The SSH host (hostname or IP address)
• The SSH port (default is 22)
• The username for your machine
• The SSH private key
• An optional passphrase if the private key is protected

After clicking Create, your SSH Connection is established and ready to use with your Hanzo KMS project.

To create an SSH Connection, make an API request to the Create SSH Connection API endpoint.

Sample request

curl    --request POST \
    --url https://app.kms.hanzo.ai/api/v1/app-connections/ssh \
    --header 'Content-Type: application/json' \
    --data '{
        "name": "my-ssh-connection",
        "method": "ssh-key",
        "projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
        "credentials": {
            "host": "[ssh host]",
            "port": 22,
            "privateKey": "[SSH Private Key]",
            "username": "root"
        }
    }'

Sample response

{
    "appConnection": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "my-ssh-connection",
        "projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
        "version": 1,
        "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "app": "ssh",
        "method": "ssh-key",
        "credentials": {
            "host": "[ssh host]",
            "port": 22,
            "privateKey": "[SSH Private Key]",
            "username": "root"
        }
    }
}