Chef Sync

If you're using Infisical Cloud, then it is available under the **Enterprise Tier**. If you're self-hosting Infisical,
then you should contact [email protected] to purchase an enterprise license to use it.

    ![Secret Syncs Tab](/images/secret-syncs/general/secret-sync-tab.png)
  </Step>
  <Step title="Select 'Chef'">
    ![Select Chef](/images/secret-syncs/chef/select-option.png)
  </Step>
  <Step title="Configure source">
    Configure the **Source** from where secrets should be retrieved, then click **Next**.

    ![Configure Source](/images/secret-syncs/chef/sync-source.png)

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

    <Tip>
      If you need to sync secrets from multiple folder locations, check out [secret imports](/documentation/platform/secret-reference#secret-imports).
    </Tip>
  </Step>
  <Step title="Configure destination">
    Configure the **Destination** to where secrets should be deployed, then click **Next**.

    ![Configure Destination](/images/secret-syncs/chef/sync-destination.png)

    - **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.
  </Step>
  <Step title="Configure Sync Options">
    Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.

    ![Configure Options](/images/secret-syncs/chef/sync-options.png)

    - **Initial Sync Behavior**: Determines how Infisical should resolve the initial sync.
        - **Overwrite Destination Secrets**: Removes any secrets at the destination endpoint not present in Infisical.
        - **Import Secrets (Prioritize Infisical)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Infisical over Chef when keys conflict.
        - **Import Secrets (Prioritize Chef)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Chef over Infisical 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.
    <Note>
      We highly recommend using a Key Schema to ensure that Infisical only manages the specific keys you intend, keeping everything else untouched.
    </Note>
    - **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, Infisical will not remove secrets from the sync destination. Enable this option if you intend to manage some secrets manually outside of Infisical.
  </Step>
  <Step title="Configure details">
    Configure the **Details** of your Chef Sync, then click **Next**.

    ![Configure Details](/images/secret-syncs/chef/sync-details.png)

    - **Name**: The name of your sync. Must be slug-friendly.
    - **Description**: An optional description for your sync.
  </Step>
  <Step title="Review configuration">
    Review your Chef Sync configuration, then click **Create Sync**.

    ![Review Configuration](/images/secret-syncs/chef/sync-review.png)
  </Step>
  <Step title="Sync created">
    If enabled, your Chef Sync will begin syncing your secrets to the destination endpoint.

    ![Sync Created](/images/secret-syncs/chef/sync-created.png)
  </Step>
</Steps>

### Sample request

```bash Request
curl    --request POST \
        --url https://app.infisical.com/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

```bash 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"
        }
    }
}
```