Chef Connection

Chef App Connection is a paid feature.

If you download a new starter kit, your previous private key/user key will no longer be valid. Please make sure to update all the places that use the previous private key.

Open your starter kit's folder(or chef-repo) and navigate to the .chef folder.

Please make sure you have hidden files visible in your file explorer.

In the .chef folder, you will find a [your-username].pem file.

Private Key: Copy the content of the private key file.

Open the config.rb file and copy the content of the file.

User Name(1): The user name of the chef user.

Server URL(2): The server url of the chef server.

Organization Name(3): The organization name of the chef server.

Create a Chef Connection in Hanzo KMS via UI

In your Hanzo KMS dashboard, navigate to the Integrations tab in the desired project, then select App Connections.

Click + Add Connection and choose Chef Connection from the list of integrations.

Complete the form by providing:

• A descriptive name for the connection
• An optional description
• Server URL(optional): The URL of the Chef server to connect with (defaults to https://api.chef.io)
• Organization short name
• User name
• Private key: Your Chef user's private key (.pem file)

After submitting the form, your Chef Connection will be successfully created and ready to use with your Hanzo KMS project.

To create a Chef Connection via API, send a request to the Create Chef Connection endpoint.

Sample request

curl    --request POST \
        --url https://app.kms.hanzo.ai/api/v1/app-connections/chef \
        --header 'Content-Type: application/json' \
        --data '{
            "name": "my-chef-connection",
            "method": "user-key",
            "projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
            "credentials": {
                "orgName": "my-org",
                "userName": "my-user",
                "privateKey": "your-private-key"
            }
        }'

Sample response

{
  "appConnection": {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "name": "my-chef-connection",
      "description": null,
      "projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
      "version": 1,
      "orgId": "abcdef12-3456-7890-abcd-ef1234567890",
      "createdAt": "2025-10-13T10:15:00.000Z",
      "updatedAt": "2025-10-13T10:15:00.000Z",
      "isPlatformManagedCredentials": false,
      "credentialsHash": "d41d8cd98f00b204e9800998ecf8427e",
      "app": "chef",
      "method": "user-key",
      "credentials": {
        "orgName": "my-org",
        "userName": "my-user",
      }
  }
}