Northflank Sync

Learn how to configure a Northflank Sync for Infisical.

Prerequisites:

• Create a Northflank Connection

Infisical UI

1. Add Sync

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

   
2. Select 'Northflank'

   
3. Configure source

   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 destination

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

   

   • Northflank Connection: The Northflank Connection to authenticate with.
   • Project: The Northflank project to sync secrets to.
   • Secret Group: The Northflank secret group to sync secrets to.
5. Configure sync options

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

   

   • 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 Destination Secrets - Prioritize Infisical Values: Imports any secrets present in the Northflank destination prior to syncing, prioritizing values from Infisical over Northflank when keys conflict.
     • Import Destination Secrets - Prioritize Northflank Values: Imports any secrets present in the Northflank destination prior to syncing, prioritizing values from Northflank 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.

   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 Northflank Sync, then click Next.

   

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

   Review your Northflank Sync configuration, then click Create Sync.

   
8. Sync created

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

   

API

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

Sample request

Request

curl    --request POST \
        --url https://app.infisical.com/api/v1/secret-syncs/northflank \
        --header 'Content-Type: application/json' \
        --data '{
            "name": "my-northflank-sync",
            "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "an example sync",
            "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "environment": "dev",
            "secretPath": "/my-secrets",
            "isAutoSyncEnabled": true,
            "syncOptions": {
                "initialSyncBehavior": "overwrite-destination",
                "keySchema": "INFISICAL_{{secretKey}}"
            },
            "destinationConfig": {
                "projectId": "my-project-id",
                "secretGroupId": "my-secret-group-id"
            }
        }'

Sample response

Response

{
    "secretSync": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "my-northflank-sync",
        "description": "an example sync",
        "isAutoSyncEnabled": 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",
            "keySchema": "INFISICAL_{{secretKey}}",
            "disableSecretDeletion": false
        },
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "connection": {
            "app": "northflank",
            "name": "my-northflank-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": "northflank",
        "destinationConfig": {
            "projectId": "my-project-id",
            "secretGroupId": "my-secret-group-id"
        }
    }
}