feat: Add Netlify app connection and secrets sync (#4205)

* fix: save wip * feat: final impl * feat: docs * Update backend/src/services/app-connection/digital-ocean/digital-ocean-connection-service.ts Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * chore: remove empty conflict files * Update backend/src/server/routes/v1/app-connection-routers/app-connection-router.ts Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update frontend/src/components/secret-syncs/forms/schemas/digital-ocean-app-platform-sync-destination-schema.ts Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update frontend/src/components/secret-syncs/forms/schemas/digital-ocean-app-platform-sync-destination-schema.ts Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update frontend/src/components/secret-syncs/forms/SecretSyncDestinationFields/DigitalOceanAppPlatformSyncFields.tsx Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update backend/src/services/secret-sync/digital-ocean-app-platform/digital-ocean-app-platform-sync-schemas.ts Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * fix: lint * feat: Netlify app connection and secrets sync * feat: docs * fix: type check * fix: api client * fix: lint and types * fix: typecheck lint * fix: docs * fix: lint * fix: lint * fix: PR changes * fix: typecheck * fix: PR changes * fix PR changes * fix: PR Change * fix: type error * Small tweaks * fix: support is_secret * fix: revert is_secret * fix: force update existing netlify secret --------- Co-authored-by: sidwebworks <xodeveloper@gmail.com> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Co-authored-by: x032205 <x032205@gmail.com>
2026-09-22 13:39:35 +00:00 · 2025-08-01 00:24:40 +05:30
parent 3877fe524d
commit 79de7c5f08
90 changed files with 1747 additions and 2 deletions
--- a/docs/api-reference/endpoints/app-connections/netlify/available.mdx
+++ b/docs/api-reference/endpoints/app-connections/netlify/available.mdx
@@ -0,0 +1,4 @@
+---
+title: "Available"
+openapi: "GET /api/v1/app-connections/netlify/available"
+---
--- a/docs/api-reference/endpoints/app-connections/netlify/create.mdx
+++ b/docs/api-reference/endpoints/app-connections/netlify/create.mdx
@@ -0,0 +1,8 @@
+---
+title: "Create"
+openapi: "POST /api/v1/app-connections/netlify"
+---
+
+<Note>
+    Check out the configuration docs for [Netlify Connections](/integrations/app-connections/netlify) to learn how to obtain the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/app-connections/netlify/delete.mdx
+++ b/docs/api-reference/endpoints/app-connections/netlify/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/app-connections/netlify/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/netlify/get-by-id.mdx
+++ b/docs/api-reference/endpoints/app-connections/netlify/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/app-connections/netlify/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/netlify/get-by-name.mdx
+++ b/docs/api-reference/endpoints/app-connections/netlify/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/app-connections/netlify/connection-name/{connectionName}"
+---
--- a/docs/api-reference/endpoints/app-connections/netlify/list.mdx
+++ b/docs/api-reference/endpoints/app-connections/netlify/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/app-connections/netlify"
+---
--- a/docs/api-reference/endpoints/app-connections/netlify/update.mdx
+++ b/docs/api-reference/endpoints/app-connections/netlify/update.mdx
@@ -0,0 +1,8 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/app-connections/netlify/{connectionId}"
+---
+
+<Note>
+    Check out the configuration docs for [Netlify Connections](/integrations/app-connections/netlify) to learn how to obtain the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/secret-syncs/netlify/create.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/netlify/create.mdx
@@ -0,0 +1,4 @@
+---
+title: "Create"
+openapi: "POST /api/v1/secret-syncs/netlify"
+---
--- a/docs/api-reference/endpoints/secret-syncs/netlify/delete.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/netlify/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/secret-syncs/netlify/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/netlify/get-by-id.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/netlify/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/secret-syncs/netlify/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/netlify/get-by-name.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/netlify/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/secret-syncs/netlify/sync-name/{syncName}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/netlify/import-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/netlify/import-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Import Secrets"
+openapi: "POST /api/v1/secret-syncs/netlify/{syncId}/import-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/netlify/list.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/netlify/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/secret-syncs/netlify"
+---
--- a/docs/api-reference/endpoints/secret-syncs/netlify/remove-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/netlify/remove-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Remove Secrets"
+openapi: "POST /api/v1/secret-syncs/netlify/{syncId}/remove-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/netlify/sync-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/netlify/sync-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Sync Secrets"
+openapi: "POST /api/v1/secret-syncs/netlify/{syncId}/sync-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/netlify/update.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/netlify/update.mdx
@@ -0,0 +1,4 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/secret-syncs/netlify/{syncId}"
+---
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -497,6 +497,7 @@
                  "integrations/app-connections/ldap",
                  "integrations/app-connections/mssql",
                  "integrations/app-connections/mysql",
+                  "integrations/app-connections/netlify",
                  "integrations/app-connections/oci",
                  "integrations/app-connections/okta",
                  "integrations/app-connections/oracledb",
@@ -540,6 +541,7 @@
                  "integrations/secret-syncs/hashicorp-vault",
                  "integrations/secret-syncs/heroku",
                  "integrations/secret-syncs/humanitec",
+                  "integrations/secret-syncs/netlify",
                  "integrations/secret-syncs/oci-vault",
                  "integrations/secret-syncs/railway",
                  "integrations/secret-syncs/render",
@@ -1557,6 +1559,18 @@
                      "api-reference/endpoints/app-connections/mysql/update",
                      "api-reference/endpoints/app-connections/mysql/delete"
                    ]
+                  },
+                   {
+                    "group": "Netlify",
+                    "pages": [
+                      "api-reference/endpoints/app-connections/netlify/list",
+                      "api-reference/endpoints/app-connections/netlify/available",
+                      "api-reference/endpoints/app-connections/netlify/get-by-id",
+                      "api-reference/endpoints/app-connections/netlify/get-by-name",
+                      "api-reference/endpoints/app-connections/netlify/create",
+                      "api-reference/endpoints/app-connections/netlify/update",
+                      "api-reference/endpoints/app-connections/netlify/delete"
+                    ]
                  },
                  {
                    "group": "OCI",
@@ -1978,6 +1992,19 @@
                      "api-reference/endpoints/secret-syncs/humanitec/remove-secrets"
                    ]
                  },
+                  {
+                    "group": "Netlify",
+                    "pages": [
+                      "api-reference/endpoints/secret-syncs/netlify/list",
+                      "api-reference/endpoints/secret-syncs/netlify/get-by-id",
+                      "api-reference/endpoints/secret-syncs/netlify/get-by-name",
+                      "api-reference/endpoints/secret-syncs/netlify/create",
+                      "api-reference/endpoints/secret-syncs/netlify/update",
+                      "api-reference/endpoints/secret-syncs/netlify/delete",
+                      "api-reference/endpoints/secret-syncs/netlify/sync-secrets",
+                      "api-reference/endpoints/secret-syncs/netlify/remove-secrets"
+                    ]
+                  },
                  {
                    "group": "OCI",
                    "pages": [
--- a/docs/images/app-connections/netlify/app-connection-create-api-key.png
+++ b/docs/images/app-connections/netlify/app-connection-create-api-key.png
--- a/docs/images/app-connections/netlify/app-connection-create-form.png
+++ b/docs/images/app-connections/netlify/app-connection-create-form.png
--- a/docs/images/app-connections/netlify/app-connection-dashboard.png
+++ b/docs/images/app-connections/netlify/app-connection-dashboard.png
--- a/docs/images/app-connections/netlify/app-connection-form.png
+++ b/docs/images/app-connections/netlify/app-connection-form.png
--- a/docs/images/app-connections/netlify/app-connection-generated.png
+++ b/docs/images/app-connections/netlify/app-connection-generated.png
--- a/docs/images/app-connections/netlify/app-connection-key-generated.png
+++ b/docs/images/app-connections/netlify/app-connection-key-generated.png
--- a/docs/images/app-connections/netlify/app-connection-option.png
+++ b/docs/images/app-connections/netlify/app-connection-option.png
--- a/docs/images/app-connections/netlify/app-connection-profile.png
+++ b/docs/images/app-connections/netlify/app-connection-profile.png
--- a/docs/images/secret-syncs/netlify/select-option.png
+++ b/docs/images/secret-syncs/netlify/select-option.png
--- a/docs/images/secret-syncs/netlify/sync-created.png
+++ b/docs/images/secret-syncs/netlify/sync-created.png
--- a/docs/images/secret-syncs/netlify/sync-destination.png
+++ b/docs/images/secret-syncs/netlify/sync-destination.png
--- a/docs/images/secret-syncs/netlify/sync-details.png
+++ b/docs/images/secret-syncs/netlify/sync-details.png
--- a/docs/images/secret-syncs/netlify/sync-options.png
+++ b/docs/images/secret-syncs/netlify/sync-options.png
--- a/docs/images/secret-syncs/netlify/sync-review.png
+++ b/docs/images/secret-syncs/netlify/sync-review.png
--- a/docs/images/secret-syncs/netlify/sync-source.png
+++ b/docs/images/secret-syncs/netlify/sync-source.png
--- a/docs/integrations/app-connections/netlify.mdx
+++ b/docs/integrations/app-connections/netlify.mdx
@@ -0,0 +1,102 @@
+---
+title: "Netlify Connection"
+description: "Learn how to configure a Netlify Connection for Infisical."
+---
+
+Infisical supports the use of [Personal Access Tokens](https://docs.netlify.com/api/get-started/#get-access-tokens) to connect with Netlify.  
+<Note>
+  Netlify requires the token to have **full access** to enable secret management for your sites and services.
+</Note>
+
+## Create a Netlify Personal Access Token
+
+<Steps>
+  <Step title="From your Netlify dashboard, click on your user avatar and go to 'User settings'">
+    ![Netlify User Settings](/images/app-connections/netlify/app-connection-profile.png)
+  </Step>
+  <Step title="In the left sidebar, click on 'Applications' and scroll to 'Personal Access Tokens'">
+    ![Applications Tab](/images/app-connections/netlify/app-connection-create-api-key.png)
+  </Step>
+  <Step title="Click 'New access token'">
+    Provide a name for your token and generate it.
+
+    ![Token Form](/images/app-connections/netlify/app-connection-create-form.png)
+  </Step>
+  <Step title="Copy the token securely">
+    Make sure to copy the token now—you won’t be able to access it again.
+
+    ![Token Generated](/images/app-connections/netlify/app-connection-key-generated.png)
+  </Step>
+</Steps>
+
+## Create a Netlify Connection in Infisical
+
+<Tabs>
+  <Tab title="Infisical UI">
+    <Steps>
+      <Step title="Navigate to App Connections">
+        In your Infisical dashboard, go to **Organization Settings** and open the [**App Connections**](https://app.infisical.com/organization/app-connections) tab.
+
+        ![App Connections Tab](/images/app-connections/general/add-connection.png)
+      </Step>
+      <Step title="Select Netlify Connection">
+        Click **+ Add Connection** and choose **Netlify Connection** from the list of integrations.
+
+        ![Select Netlify Connection](/images/app-connections/netlify/app-connection-option.png)
+      </Step>
+      <Step title="Fill out the Netlify Connection form">
+        Complete the form by providing:
+        - A descriptive name for the connection
+        - An optional description
+        - The API Token from the previous step
+
+        ![Netlify Connection Modal](/images/app-connections/netlify/app-connection-form.png)
+      </Step>
+      <Step title="Connection created">
+        After submitting the form, your **Netlify Connection** will be successfully created and ready to use with your Infisical projects.
+
+        ![Netlify Connection Created](/images/app-connections/netlify/app-connection-generated.png)
+      </Step>
+    </Steps>
+  </Tab>
+
+  <Tab title="API">
+    To create a Netlify Connection via API, send a request to the [Create Netlify Connection](/api-reference/endpoints/app-connections/netlify/create) endpoint.
+
+    ### Sample request
+
+    ```bash Request
+    curl    --request POST \
+            --url https://app.infisical.com/api/v1/app-connections/netlify \
+            --header 'Content-Type: application/json' \
+            --data '{
+                "name": "my-netlify-connection",
+                "method": "access-token",
+                "credentials": {
+                    "accessToken": "[ACCESS TOKEN]"
+                }
+            }'
+    ```
+
+    ### Sample response
+
+    ```bash Response
+    {
+      "appConnection": {
+          "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
+          "name": "my-netlify-connection",
+          "description": null,
+          "version": 1,
+          "orgId": "abcdef12-3456-7890-abcd-ef1234567890",
+          "createdAt": "2025-07-19T10:15:00.000Z",
+          "updatedAt": "2025-07-19T10:15:00.000Z",
+          "isPlatformManagedCredentials": false,
+          "credentialsHash": "d41d8cd98f00b204e9800998ecf8427e",
+          "app": "netlify",
+          "method": "access-token",
+          "credentials": {}
+      }
+    }
+    ```
+  </Tab>
+</Tabs>
--- a/docs/integrations/secret-syncs/netlify.mdx
+++ b/docs/integrations/secret-syncs/netlify.mdx
@@ -0,0 +1,161 @@
+---
+title: "Netlify Sync"
+description: "Learn how to configure a Netlify Sync for Infisical."
+---
+
+**Prerequisites:**
+
+- Create a [Netlify Connection](/integrations/app-connections/netlify)
+
+<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 'Netlify'">
+        ![Select Netlify](/images/secret-syncs/netlify/select-option.png)
+      </Step>
+      <Step title="Configure source">
+        Configure the **Source** from where secrets should be retrieved, then click **Next**.
+
+        ![Configure Source](/images/secret-syncs/netlify/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>
+      </Step>
+      <Step title="Configure destination">
+        Configure the **Destination** to where secrets should be deployed, then click **Next**.
+
+        ![Configure Destination](/images/secret-syncs/netlify/sync-destination.png)
+
+        - **Netlify Connection**: The Netlify Connection to authenticate with.
+        - **Account**: The Netlify Account to be used.
+        - **Site**: The Netlify site where secrets should be synced.
+        - **Context**: The Netlify deployment context where secrets should be created in.
+      </Step>
+      <Step title="Configure Sync Options">
+        Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
+
+        ![Configure Options](/images/secret-syncs/netlify/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 destination endpoint before syncing, prioritizing values from Infisical over Netlify when keys conflict.
+            - **Import Secrets (Prioritize Netlify)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Netlify over Infisical when keys conflict.
+        <Note>
+          Netlify only supports importing non-secret values.
+        </Note>
+        - **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 Netlify Sync, then click **Next**.
+
+        ![Configure Details](/images/secret-syncs/netlify/sync-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 Netlify Sync configuration, then click **Create Sync**.
+
+        ![Review Configuration](/images/secret-syncs/netlify/sync-review.png)
+      </Step>
+      <Step title="Sync created">
+        If enabled, your Netlify Sync will begin syncing your secrets to the destination endpoint.
+
+        ![Sync Created](/images/secret-syncs/netlify/sync-created.png)
+      </Step>
+    </Steps>
+  </Tab>
+
+  <Tab title="API">
+    To create a **Netlify Sync**, make an API request to the [Create Netlify Sync](/api-reference/endpoints/secret-syncs/netlify/create) API endpoint.
+
+    ### Sample request
+
+    ```bash Request
+    curl    --request POST \
+            --url https://app.infisical.com/api/v1/secret-syncs/netlify \
+            --header 'Content-Type: application/json' \
+            --data '{
+                "name": "my-netlify-sync",
+                "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "description": "sync to netlify site",
+                "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "environment": "production",
+                "secretPath": "/site-secrets",
+                "isEnabled": true,
+                "syncOptions": {
+                    "initialSyncBehavior": "overwrite-destination",
+                    "autoSyncEnabled": true,
+                    "disableSecretDeletion": false
+                },
+                "destinationConfig": {
+                    "siteId": "site-abc123",
+                    "accountId": "account-abc123",
+                    "context": "dev"
+                }
+            }'
+    ```
+
+    ### Sample response
+
+    ```bash Response
+    {
+        "secretSync": {
+            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+            "name": "my-netlify-sync",
+            "description": "sync to netlify site",
+            "isEnabled": true,
+            "version": 1,
+            "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+            "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+            "createdAt": "2025-07-19T12:00:00Z",
+            "updatedAt": "2025-07-19T12:00:00Z",
+            "syncStatus": "succeeded",
+            "lastSyncJobId": "job-1234",
+            "lastSyncMessage": null,
+            "lastSyncedAt": "2025-07-19T12:00:00Z",
+            "syncOptions": {
+                "initialSyncBehavior": "overwrite-destination",
+                "autoSyncEnabled": true,
+                "disableSecretDeletion": false
+            },
+            "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+            "connection": {
+                "app": "netlify",
+                "name": "my-netlify-connection",
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
+            },
+            "environment": {
+                "slug": "production",
+                "name": "Production",
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
+            },
+            "folder": {
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "path": "/site-secrets"
+            },
+            "destination": "netlify",
+            "destinationConfig": {
+                "siteId": "site-abc123",
+                "accountId": "account-abc123",
+                "context": "dev"
+            }
+        }
+    }
+    ```
+  </Tab>
+</Tabs>