> ## Documentation Index
> Fetch the complete documentation index at: https://infisical.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# HashiCorp Vault sync

> Learn how to configure a HashiCorp Vault Sync for Infisical.

**Prerequisites:**

* Set up and add secrets to [Infisical Cloud](https://app.infisical.com)
* Create a [HashiCorp Vault Connection](https://infisical.com/docs/integrations/app-connections/hashicorp-vault.md)

> [tab] Infisical UI
>
> **1. Add Sync**
>
> Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Select the **Add Sync** button.
>
> ![Secret Syncs Tab](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/general/secret-sync-tab.png)
>
> **2. Select HashiCorp Vault**
>
> ![Select HashiCorp Vault](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/hashicorp-vault/select-option.png)
>
> **3. Configure Source**
>
> Configure the **Source** from where secrets should be retrieved, then click **Next**.
>
> ![Configure Source](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/hashicorp-vault/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](https://infisical.com/docs/documentation/platform/secret-reference.md#secret-imports).
>
> **4. Configure Destination**
>
> Configure the **Destination** to where secrets should be deployed.
>
> ![Configure Destination](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/hashicorp-vault/sync-destination.png)
>
> * **HashiCorp Vault Connection**: The Vault Connection to authenticate with.
> * **Secrets Engine Mount**: The secrets engine to sync secrets with (e.g., 'secret', 'kv').
> * **Path**: The specific path within the secrets engine where secrets will be stored.
>
> After configuring these parameters, click the **Next** button to continue to the Sync Options step.
>
> > [!NOTE]
> >
> > If the **path** you provide does not exist in Vault, it will be created.
>
> **5. Configure Sync Options**
>
> Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
>
> ![Configure Options](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/hashicorp-vault/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 HashiCorp Vault when keys conflict.
>   * **Import Secrets (Prioritize HashiCorp Vault)**: Imports secrets from the destination endpoint before syncing, prioritizing values from HashiCorp Vault 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.
>
> * **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.
>
> **6. Configure Details**
>
> Configure the **Details** of your HashiCorp Vault Sync, then click **Next**.
>
> ![Configure Details](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/hashicorp-vault/sync-details.png)
>
> * **Name**: The name of your sync. Must be slug-friendly.
> * **Description**: An optional description for your sync.
>
> **7. Review Configuration**
>
> Review your HashiCorp Vault Sync configuration, then click **Create Sync**.
>
> ![Confirm Configuration](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/hashicorp-vault/sync-review.png)
>
> **8. Sync Created**
>
> If enabled, your HashiCorp Vault Sync will begin syncing your secrets to the destination endpoint.
>
> ![Sync Created](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/hashicorp-vault/sync-created.png)

> [tab] API
>
> To create an **HashiCorp Vault Sync**, make an API request to the [Create HashiCorp Vault Sync](https://infisical.com/docs/api-reference/endpoints/secret-syncs/hashicorp-vault/create.md) API endpoint.
>
> ### Sample request
>
> ```bash Request theme={"dark"}
> curl    --request POST \
>         --url https://app.infisical.com/api/v1/secret-syncs/hashicorp-vault \
>         --header 'Content-Type: application/json' \
>         --data '{
>             "name": "my-vault-sync",
>             "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>             "description": "an example sync",
>             "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>             "environment": "dev",
>             "secretPath": "/",
>             "isEnabled": true,
>             "syncOptions": {
>                 "initialSyncBehavior": "overwrite-destination"
>             },
>             "destinationConfig": {
>                 "mount": "secret",
>                 "path": "dev/nested"
>             }
>         }'
> ```
>
> ### Sample response
>
> ```bash Response theme={"dark"}
> {
>     "secretSync": {
>         "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "name": "my-vault-sync",
>         "description": "an example sync",
>         "isEnabled": true,
>         "version": 1,
>         "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "createdAt": "2023-11-07T05:31:56Z",
>         "updatedAt": "2023-11-07T05:31:56Z",
>         "syncStatus": "succeeded",
>         "lastSyncJobId": "123",
>         "lastSyncMessage": null,
>         "lastSyncedAt": "2023-11-07T05:31:56Z",
>         "importStatus": null,
>         "lastImportJobId": null,
>         "lastImportMessage": null,
>         "lastImportedAt": null,
>         "removeStatus": null,
>         "lastRemoveJobId": null,
>         "lastRemoveMessage": null,
>         "lastRemovedAt": null,
>         "syncOptions": {
>             "initialSyncBehavior": "overwrite-destination"
>         },
>         "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "connection": {
>             "app": "hashicorp-vault",
>             "name": "my-vault-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": "hashicorp-vault",
>         "destinationConfig": {
>             "mount": "secret",
>             "path": "dev/nested"
>         }
>     }
> }
> ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.