Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

5.6 KB
Raw Blame
---
title: "Render sync"
sidebarTitle: "Render"
description: "Learn how to configure a Render Sync for Infisical."
---

**Prerequisites:**

- Set up and add secrets to [Infisical Cloud](https://app.infisical.com)
- Create a [Render Connection](/integrations/app-connections/render)

<Tabs>
  <Tab title="Infisical UI">
    1. Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Select the **Add Sync** button.
    ![Secret Syncs Tab](/images/secret-syncs/general/secret-sync-tab.png)

    2. Select the **Render** option.
    ![Select Render](/images/secret-syncs/render/select-render-option.png)

    3. Configure the **Source** from where secrets should be retrieved, then click **Next**.
    ![Configure Source](/images/secret-syncs/render/render-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](/documentation/platform/secret-reference#secret-imports).
      </Tip>

    4. Configure the **Destination** to where secrets should be deployed, then click **Next**.
    ![Configure Destination](/images/secret-syncs/render/render-sync-destination.png)

      - **Render Connection**: The Render Connection to authenticate with.
      - **Scope**: Select **Service** or **Environment Group**.
        - **Service**: Choose the Render service you want to sync secrets to.
        - **Environment Group**: Choose the Render environment group you want to sync secrets to.

    5. Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
    ![Configure Options](/images/secret-syncs/render/render-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 Render service before syncing, prioritizing values from Infisical over Render when keys conflict.
        - **Import Secrets (Prioritize Render)**: Imports secrets from the Render service before syncing, prioritizing values from Render 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.
      - **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 the **Details** of your Render Sync, then click **Next**.
    ![Configure Details](/images/secret-syncs/render/render-sync-details.png)

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

    7. Review your Render Sync configuration, then click **Create Sync**.
    ![Confirm Configuration](/images/secret-syncs/render/render-sync-review.png)

    8. If enabled, your Render Sync will begin syncing your secrets to the destination endpoint.
    ![Sync Secrets](/images/secret-syncs/render/render-sync-created.png)

  </Tab>
  <Tab title="API">
    To create a **Render Sync**, make an API request to the [Create Render Sync](/api-reference/endpoints/secret-syncs/render/create) API endpoint.

    ### Sample request

    ```bash Request
    curl --request POST \
      --url https://app.infisical.com/api/v1/secret-syncs/render \
      --header 'Content-Type: application/json' \
      --data '{
        "name": "my-render-sync",
        "projectId": "your-project-id",
        "description": "an example sync",
        "connectionId": "your-render-connection-id",
        "environment": "production",
        "secretPath": "/my-secrets",
        "isEnabled": true,
        "syncOptions": {
          "initialSyncBehavior": "overwrite-destination"
        },
        "destinationConfig": {
          "scope": "service",
          "serviceId": "your-render-service-id",
          "type": "env"
        }
      }'
    ```

    ### Sample response

    ```bash Response
    {
      "secretSync": {
        "id": "your-sync-id",
        "name": "my-render-sync",
        "description": "an example sync",
        "isEnabled": true,
        "version": 1,
        "folderId": "your-folder-id",
        "connectionId": "your-render-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": "render",
          "name": "my-render-connection",
          "id": "your-render-connection-id"
        },
        "environment": {
          "slug": "production",
          "name": "Production",
          "id": "your-env-id"
        },
        "folder": {
          "id": "your-folder-id",
          "path": "/my-secrets"
        },
        "destination": "render",
        "destinationConfig": {
          "scope": "service",
          "serviceId": "your-render-service-id",
          "type": "env"
        }
      }
    }
    ```

  </Tab>
</Tabs>