Back to Infisical

Ona Sync

docs/integrations/secret-syncs/ona.mdx

0.159.267.0 KB
Original Source

Prerequisites:

<Tabs> <Tab title="Infisical UI"> <Steps> <Step title="Add Sync"> Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Click on the **Add Sync** button.
            ![Secret Syncs Tab](/images/secret-syncs/general/secret-sync-tab.png)
        </Step>
        <Step title="Select 'Ona'">
            ![Select Ona](/images/secret-syncs/ona/select-ona-option.png)
        </Step>
        <Step title="Configure source">
            Configure the **Source** from where secrets should be retrieved, then click **Next**.

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

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

        </Step>
        <Step title="Configure destination">
            Configure the **Destination** to where secrets should be deployed, then click **Next**.

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

            - **Ona Connection**: The Ona Connection to authenticate with.
            - **Ona Project**: Sync secrets to the selected Ona project as project-level environment variables. Choose the target project from the dropdown populated by your connection.
        </Step>
        <Step title="Configure sync options">
            Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.

            ![Configure Sync Options](/images/secret-syncs/ona/ona-options.png)

            - **Initial Sync Behavior**: Determines how Infisical should resolve the initial sync. Ona Sync only supports **Overwrite Destination Secrets**. Any environment-variable secrets at the destination that are not present in Infisical will be removed on the first sync.
            - **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 Ona Sync, then click **Next**.

            ![Configure Details](/images/secret-syncs/ona/ona-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 Ona Sync configuration, then click **Create Sync**.

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

            ![Sync Created](/images/secret-syncs/ona/ona-created.png)
        </Step>
    </Steps>
</Tab>
<Tab title="API">
    To create an **Ona Sync**, make an API request to the [Create Ona Sync](/api-reference/endpoints/secret-syncs/ona/create) API endpoint.

    ### Sample request

    ```bash Request
    curl    --request POST \
            --url https://app.infisical.com/api/v1/secret-syncs/ona \
            --header 'Content-Type: application/json' \
            --data '{
                "name": "my-ona-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": "ona-project-uuid",
                    "projectName": "my-ona-project"
                }
            }'
    ```

    ### Sample response

    ```json Response
    {
        "secretSync": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "my-ona-sync",
            "description": "an example sync",
            "isAutoSyncEnabled": true,
            "version": 1,
            "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "createdAt": "2025-01-23T10:15:00Z",
            "updatedAt": "2025-01-23T10:15:00Z",
            "syncStatus": "succeeded",
            "lastSyncJobId": "123",
            "lastSyncMessage": null,
            "lastSyncedAt": "2025-01-23T10:15:00Z",
            "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": "ona",
                "name": "my-ona-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": "ona",
            "destinationConfig": {
                "projectId": "ona-project-uuid",
                "projectName": "my-ona-project"
            }
        }
    }
    ```
</Tab>
</Tabs>