Cloudflare Workers Sync

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

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

2. Select the Cloudflare Workers 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.

• Cloudflare Connection: The Cloudflare Connection to authenticate with.
• Cloudflare Workers Script: Choose the Cloudflare Workers script you want to sync secrets to.

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.
• 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.
• 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 Cloudflare Workers Sync, then click Next.

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

7. Review your Cloudflare Workers Sync configuration, then click Create Sync.

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

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

Sample request

curl --request POST \
  --url https://app.kms.hanzo.ai/api/v1/secret-syncs/cloudflare-workers \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "my-cloudflare-workers-sync",
    "projectId": "your-project-id",
    "description": "an example sync",
    "connectionId": "your-cloudflare-connection-id",
    "environment": "production",
    "secretPath": "/my-secrets",
    "isEnabled": true,
    "syncOptions": {
      "initialSyncBehavior": "overwrite-destination"
    },
    "destinationConfig": {
      "scriptId": "my-workers-script"
    }
  }'

Sample response

{
  "secretSync": {
    "id": "your-sync-id",
    "name": "my-cloudflare-workers-sync",
    "description": "an example sync",
    "isEnabled": true,
    "version": 1,
    "folderId": "your-folder-id",
    "connectionId": "your-cloudflare-connection-id",
    "createdAt": "2024-05-01T12:00:00Z",
    "updatedAt": "2024-05-01T12:00:00Z",
    "syncStatus": "succeeded",
    "lastSyncJobId": "123",
    "lastSyncMessage": null,
    "lastSyncedAt": "2024-05-01T12:00:00Z",
    "syncOptions": {
      "initialSyncBehavior": "overwrite-destination"
    },
    "projectId": "your-project-id",
    "connection": {
      "app": "cloudflare",
      "name": "my-cloudflare-connection",
      "id": "your-cloudflare-connection-id"
    },
    "environment": {
      "slug": "production",
      "name": "Production",
      "id": "your-env-id"
    },
    "folder": {
      "id": "your-folder-id",
      "path": "/my-secrets"
    },
    "destination": "cloudflare-workers",
    "destinationConfig": {
      "scriptId": "my-workers-script"
    }
  }
}