Vercel Sync

Feedback
Set up and add secrets to Hanzo KMS Cloud
Feedback
Create a Vercel Connection

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

2. Select the Vercel option.

3. 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.

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

   • Vercel Connection: The Vercel Connection to authenticate with.
   • Vercel App: The application to deploy secrets to.
   • Vercel App Environment: The environment to deploy secrets to.
   • Vercel Preview Branch (Optional): Specify a branch for preview deployments if needed.

After configuring these parameters, click the Next button to continue to the Sync Options step.

5. 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 Vercel when keys conflict.
     • Import Secrets (Prioritize Vercel): Imports secrets from the destination endpoint before syncing, prioritizing values from Vercel over Hanzo KMS when keys conflict.

   Vercel does not expose the values of sensitive environment variables, so Hanzo KMS cannot import them during the initial sync. As a result, these secrets are created in Hanzo KMS with empty values. After the first sync, you'll need to manually re-enter their values in Hanzo KMS to ensure both platforms stay aligned.

   • 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.

6. Configure the Details of your Vercel Sync, then click Next.

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

7. Review your Vercel Sync configuration, then click Create Sync.

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

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

Sample request

curl    --request POST \
--url https://app.kms.hanzo.ai/api/v1/secret-syncs/vercel \
--header 'Content-Type: application/json' \
--data '{
    "name": "my-vercel-sync",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "an example sync",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "environment": "dev",
    "secretPath": "/my-secrets",
    "isEnabled": true,
    "syncOptions": {
        "initialSyncBehavior": "overwrite-destination"
    },
    "destinationConfig": {
        "app": "prj_bz7zgHvQETPvJWc5tmIr0tGRH9kE",
        "env": "preview",
        "branch": "test",
        "appName": "nextjs-boilerplate",
        "teamId": "team_0d444b5088888dd257"
    }
}'

Sample response

{
    "secretSync": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "my-vercel-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": "vercel",
            "name": "my-vercel-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": "/my-secrets"
        },
        "destination": "vercel",
        "destinationConfig": {
            "app": "prj_bz7zgHvQETPvJWc5tmIr0tGRH9kE",
            "env": "preview",
            "branch": "test",
            "appName": "nextjs-boilerplate",
            "teamId": "team_0d444b5088888dd257"
        }
    }
}