Chef Sync

Chef Sync is a paid feature.

Feedback
Create a Chef Connection

Navigate to Project > Integrations and select the Secret Syncs tab. Click on the Add Sync button.

Configure the Source from where secrets should be retrieved, then click Next.

• Environment: The project environment to retrieve secrets from.
• Secret Path: The folder path to retrieve secrets from.

If you need to sync secrets from multiple folder locations, check out secret imports.

Configure the Destination to where secrets should be deployed, then click Next.

• Chef Connection: The Chef Connection to authenticate with.
• Data Bag: The Data Bag to sync secrets to.
• Data Bag Item: The Data Bag Item to sync secrets to.

Configure the Sync Options to specify how secrets should be synced, then click Next.

• Initial Sync Behavior: Determines how Hanzo KMS should resolve the initial sync.
  • Overwrite Destination Secrets: Removes any secrets at the destination endpoint not present in Hanzo KMS.
  • Import Secrets (Prioritize Hanzo KMS): Imports secrets from the destination endpoint before syncing, prioritizing values from Hanzo KMS over Chef when keys conflict.
  • Import Secrets (Prioritize Chef): Imports secrets from the destination endpoint before syncing, prioritizing values from Chef over Hanzo KMS when keys conflict.
• Key Schema: Template that determines how secret names are transformed when syncing, using {{secretKey}} as a placeholder for the original secret name and {{environment}} for the environment.

We highly recommend using a Key Schema to ensure that Hanzo KMS only manages the specific keys you intend, keeping everything else untouched.

• Auto-Sync Enabled: If enabled, secrets will automatically be synced from the source location when changes occur. Disable to enforce manual syncing only.
• Disable Secret Deletion: If enabled, Hanzo KMS will not remove secrets from the sync destination. Enable this option if you intend to manage some secrets manually outside of Hanzo KMS.

Configure the Details of your Chef Sync, then click Next.

• Name: The name of your sync. Must be slug-friendly.
• Description: An optional description for your sync.

Review your Chef Sync configuration, then click Create Sync.

If enabled, your Chef Sync will begin syncing your secrets to the destination endpoint.

To create a Chef Sync, make an API request to the Create Chef Sync API endpoint.

Sample request

curl    --request POST \
        --url https://app.kms.hanzo.ai/api/v1/secret-syncs/chef \
        --header 'Content-Type: application/json' \
        --data '{
            "name": "my-chef-sync",
            "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "sync to chef site",
            "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "environment": "dev",
            "secretPath": "/",
            "isEnabled": true,
            "isAutoSyncEnabled": true,
            "syncOptions": {
                "initialSyncBehavior": "overwrite-destination",
                "disableSecretDeletion": false
            },
            "destinationConfig": {
                "dataBagName": "my-data-bag",
                "dataBagItemName": "my-data-bag-item"
            }
        }'

Sample response

{
    "secretSync": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "my-chef-sync",
        "description": "sync to chef site",
        "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2025-07-19T12:00:00Z",
        "updatedAt": "2025-07-19T12:00:00Z",
        "syncStatus": "succeeded",
        "lastSyncJobId": "job-1234",
        "lastSyncMessage": null,
        "lastSyncedAt": "2025-07-19T12:00:00Z",
        "syncOptions": {
            "initialSyncBehavior": "overwrite-destination",
            "disableSecretDeletion": false
        },
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "connection": {
            "app": "chef",
            "name": "my-chef-connection",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "environment": {
            "slug": "dev",
            "name": "Development",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "folder": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "path": "/"
        },
        "destination": "chef",
        "destinationConfig": {
            "dataBagName": "my-data-bag",
            "dataBagItemName": "my-data-bag-item"
        }
    }
}