feature: windmill connection and sync

2026-09-22 13:39:35 +00:00 · 2025-04-15 19:10:13 -07:00
parent 0f7e8585dc
commit 357381b0d6
90 changed files with 1548 additions and 49 deletions
--- a/docs/api-reference/endpoints/app-connections/windmill/available.mdx
+++ b/docs/api-reference/endpoints/app-connections/windmill/available.mdx
@@ -0,0 +1,4 @@
+---
+title: "Available"
+openapi: "GET /api/v1/app-connections/windmill/available"
+---
--- a/docs/api-reference/endpoints/app-connections/windmill/create.mdx
+++ b/docs/api-reference/endpoints/app-connections/windmill/create.mdx
@@ -0,0 +1,9 @@
+---
+title: "Create"
+openapi: "POST /api/v1/app-connections/windmill"
+---
+
+<Note>
+    Check out the configuration docs for [Windmill Connections](/integrations/app-connections/windmill) to learn how to obtain
+    the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/app-connections/windmill/delete.mdx
+++ b/docs/api-reference/endpoints/app-connections/windmill/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/app-connections/windmill/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/windmill/get-by-id.mdx
+++ b/docs/api-reference/endpoints/app-connections/windmill/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/app-connections/windmill/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/windmill/get-by-name.mdx
+++ b/docs/api-reference/endpoints/app-connections/windmill/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/app-connections/windmill/connection-name/{connectionName}"
+---
--- a/docs/api-reference/endpoints/app-connections/windmill/list.mdx
+++ b/docs/api-reference/endpoints/app-connections/windmill/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/app-connections/windmill"
+---
--- a/docs/api-reference/endpoints/app-connections/windmill/update.mdx
+++ b/docs/api-reference/endpoints/app-connections/windmill/update.mdx
@@ -0,0 +1,9 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/app-connections/windmill/{connectionId}"
+---
+
+<Note>
+    Check out the configuration docs for [Windmill Connections](/integrations/app-connections/windmill) to learn how to obtain
+    the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/secret-syncs/windmill/create.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/windmill/create.mdx
@@ -0,0 +1,4 @@
+---
+title: "Create"
+openapi: "POST /api/v1/secret-syncs/windmill"
+---
--- a/docs/api-reference/endpoints/secret-syncs/windmill/delete.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/windmill/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/secret-syncs/windmill/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/windmill/get-by-id.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/windmill/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/secret-syncs/windmill/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/windmill/get-by-name.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/windmill/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/secret-syncs/windmill/sync-name/{syncName}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/windmill/import-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/windmill/import-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Import Secrets"
+openapi: "POST /api/v1/secret-syncs/windmill/{syncId}/import-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/windmill/list.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/windmill/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/secret-syncs/windmill"
+---
--- a/docs/api-reference/endpoints/secret-syncs/windmill/remove-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/windmill/remove-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Remove Secrets"
+openapi: "POST /api/v1/secret-syncs/windmill/{syncId}/remove-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/windmill/sync-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/windmill/sync-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Sync Secrets"
+openapi: "POST /api/v1/secret-syncs/windmill/{syncId}/sync-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/windmill/update.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/windmill/update.mdx
@@ -0,0 +1,4 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/secret-syncs/windmill/{syncId}"
+---
--- a/docs/images/app-connections/windmill/create-windmill-access-token.png
+++ b/docs/images/app-connections/windmill/create-windmill-access-token.png
--- a/docs/images/app-connections/windmill/select-windmill-connection.png
+++ b/docs/images/app-connections/windmill/select-windmill-connection.png
--- a/docs/images/app-connections/windmill/windmill-access-token-created.png
+++ b/docs/images/app-connections/windmill/windmill-access-token-created.png
--- a/docs/images/app-connections/windmill/windmill-account-settings.png
+++ b/docs/images/app-connections/windmill/windmill-account-settings.png
--- a/docs/images/app-connections/windmill/windmill-copy-token.png
+++ b/docs/images/app-connections/windmill/windmill-copy-token.png
--- a/docs/images/app-connections/windmill/windmill-create-token.png
+++ b/docs/images/app-connections/windmill/windmill-create-token.png
--- a/docs/images/app-connections/windmill/windmill-new-token.png
+++ b/docs/images/app-connections/windmill/windmill-new-token.png
--- a/docs/images/secret-syncs/windmill/select-windmill-option.png
+++ b/docs/images/secret-syncs/windmill/select-windmill-option.png
--- a/docs/images/secret-syncs/windmill/windmill-sync-created.png
+++ b/docs/images/secret-syncs/windmill/windmill-sync-created.png
--- a/docs/images/secret-syncs/windmill/windmill-sync-destination.png
+++ b/docs/images/secret-syncs/windmill/windmill-sync-destination.png
--- a/docs/images/secret-syncs/windmill/windmill-sync-details.png
+++ b/docs/images/secret-syncs/windmill/windmill-sync-details.png
--- a/docs/images/secret-syncs/windmill/windmill-sync-options.png
+++ b/docs/images/secret-syncs/windmill/windmill-sync-options.png
--- a/docs/images/secret-syncs/windmill/windmill-sync-review.png
+++ b/docs/images/secret-syncs/windmill/windmill-sync-review.png
--- a/docs/images/secret-syncs/windmill/windmill-sync-source.png
+++ b/docs/images/secret-syncs/windmill/windmill-sync-source.png
--- a/docs/integrations/app-connections/windmill.mdx
+++ b/docs/integrations/app-connections/windmill.mdx
@@ -0,0 +1,102 @@
+---
+title: "Windmill Connection"
+description: "Learn how to configure a Windmill Connection for Infisical."
+---
+
+Infisical supports connecting to Windmill using an **Access Token** to securely sync your secrets to Windmill.
+
+## Get a Windmill Access Token
+
+<Steps>
+    <Step title="Navigate to Account Setting">
+        In Windmill, click on your user in the sidebar and select **Account Settings**.
+        ![Windmill Account Settings](/images/app-connections/windmill/windmill-account-settings.png)
+    </Step>
+    <Step title="Access Token Section">
+        In the **Tokens** section on the drawer, click **Create token**.
+        ![Windmill Create Token](/images/app-connections/windmill/windmill-create-token.png)
+    </Step>
+    <Step title="Create Access Token">
+        Give your token a name and click **New token**.
+        <Note>
+            If you configure an expiry date for your access token, you must manually rotate to a new token before the expiration date to prevent service interruption.
+        </Note>
+        ![Windmill New Token](/images/app-connections/windmill/windmill-new-token.png)
+    </Step>
+    <Step title="Copy Access Token">
+        Copy your new access token and save it for the steps below.
+        ![Windmill Create Token](/images/app-connections/windmill/windmill-copy-token.png)
+    </Step>
+</Steps>
+
+
+## Setup a Windmill Connection in Infisical
+
+
+<Tabs>
+    <Tab title="Infisical UI">
+        <Steps>
+            <Step title="Navigate to App Connections">
+                In your Infisical dashboard, go to **Organization Settings** and select the **App Connections** tab.
+                ![App Connections Tab](/images/app-connections/general/add-connection.png)
+            </Step>
+            <Step title="Add Connection">
+                Click the **+ Add Connection** button and select the **Windmill Connection** option.
+                ![Select Windmill Connection](/images/app-connections/windmill/select-windmill-connection.png)
+            </Step>
+            <Step title="Configure Connection">
+                Configure your Windmill Connection using the access token generated in the steps above. Then click **Connect to Windmill**.
+                ![Windmill Configure Connection](/images/app-connections/windmill/create-windmill-access-token.png)
+
+                - **Name**: The name of the connection to be created. Must be slug-friendly.
+                - **Description**: An optional description to provide details about this connection.
+                - **Instance URL**: The URL of your Windmill instance. If you are not self-hosting Windmill you can leave this field blank.
+                - **Access Token**: The access token generated in the steps above.
+            </Step>
+            <Step title="Connection Created">
+                Your Windmill Connection is now available for use.
+                ![Windmill Connection Created](/images/app-connections/windmill/windmill-access-token-created.png)
+            </Step>
+        </Steps>
+    </Tab>
+    <Tab title="API">
+        To create a Windmill Connection, make an API request to the [Create Windmill
+        Connection](/api-reference/endpoints/app-connections/windmill/create) API endpoint.
+
+        ### Sample request
+
+        ```bash Request
+        curl    --request POST \
+                --url https://app.infisical.com/api/v1/app-connections/windmill \
+                --header 'Content-Type: application/json' \
+                --data '{
+                    "name": "my-windmill-connection",
+                    "method": "access-token",
+                    "credentials": {
+                        "token": "...",
+                        "instanceUrl": "https://app.windmill.dev"
+                    }
+                }'
+        ```
+
+        ### Sample response
+
+        ```bash Response
+        {
+            "appConnection": {
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "name": "my-windmill-connection",
+                "version": 123,
+                "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "createdAt": "2025-04-01T05:31:56Z",
+                "updatedAt": "2025-04-01T05:31:56Z",
+                "app": "windmill",
+                "method": "access-token",
+                "credentials": {
+                    "instanceUrl": "https://app.windmill.dev"
+                }
+            }
+        }
+        ```
+    </Tab>
+</Tabs>
--- a/docs/integrations/secret-syncs/windmill.mdx
+++ b/docs/integrations/secret-syncs/windmill.mdx
@@ -0,0 +1,147 @@
+---
+title: "Windmill Sync"
+description: "Learn how to configure a Windmill Sync for Infisical."
+---
+
+**Prerequisites:**
+
+        - Set up and add secrets to [Infisical Cloud](https://app.infisical.com)
+        - Create a [Windmill Connection](/integrations/app-connections/windmill)
+
+<Tabs>
+    <Tab title="Infisical UI">
+        1. 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)
+
+        2. Select the **Windmill** option.
+        ![Select Windmill](/images/secret-syncs/windmill/select-windmill-option.png)
+
+        3. Configure the **Source** from where secrets should be retrieved, then click **Next**.
+        ![Configure Source](/images/secret-syncs/windmill/windmill-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/windmill/windmill-sync-destination.png)
+
+            - **Windmill Connection**: The Windmill Connection to authenticate with.
+            - **Workspace**: The Windmill workspace to sync secrets to.
+            - **Path**: The workspace path to sync secrets to.
+
+            <Note>
+                Workspace path must conform to Windmill's [owner path convention](https://www.windmill.dev/docs/core_concepts/roles_and_permissions#path).
+            </Note>
+
+        5. Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
+        ![Configure Options](/images/secret-syncs/windmill/windmill-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 Vercel when keys conflict.
+                - **Import Secrets (Prioritize Windmill)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Windmill over Infisical when keys conflict.
+            - **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 Windmill Sync, then click **Next**.
+        ![Configure Details](/images/secret-syncs/windmill/windmill-sync-details.png)
+
+            - **Name**: The name of your sync. Must be slug-friendly.
+            - **Description**: An optional description for your sync.
+
+        7. Review your Windmill Sync configuration, then click **Create Sync**.
+        ![Confirm Configuration](/images/secret-syncs/windmill/windmill-sync-review.png)
+
+        8. If enabled, your Windmill Sync will begin syncing your secrets to the destination endpoint.
+        ![Sync Secrets](/images/secret-syncs/windmill/windmill-sync-created.png)
+
+    </Tab>
+    <Tab title="API">
+        To create an **Windmill Sync**, make an API request to the [Create Windmill Sync](/api-reference/endpoints/secret-syncs/windmill/create) API endpoint.
+
+        ### Sample request
+
+        ```bash Request
+        curl    --request POST \
+        --url https://app.infisical.com/api/v1/secret-syncs/windmill \
+        --header 'Content-Type: application/json' \
+        --data '{
+            "name": "my-windmill-sync",
+            "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+            "description": "an example sync",
+            "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+            "environment": "dev",
+            "secretPath": "/my-secrets",
+            "isEnabled": true,
+            "syncOptions": {
+                "initialSyncBehavior": "overwrite-destination"
+            },
+            "destinationConfig": {
+                "workspace": "my-workspace",
+                "path": "f/folder/path/"
+            }
+        }'
+        ```
+
+        <Note>
+            Workspace path must conform to Windmill's [owner path convention](https://www.windmill.dev/docs/core_concepts/roles_and_permissions#path).
+        </Note>
+
+        ### Sample response
+
+        ```bash Response
+        {
+            "secretSync": {
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "name": "my-windmill-sync",
+                "description": "an example sync",
+                "isEnabled": 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"
+                },
+                "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "connection": {
+                    "app": "windmill",
+                    "name": "my-windmill-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": "windmill",
+                "destinationConfig": {
+                    "workspace": "my-workspace",
+                    "path": "f/folder/path/"
+                }
+            }
+        }
+        ```
+    </Tab>
+</Tabs>
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -425,7 +425,8 @@
            "integrations/app-connections/mssql",
            "integrations/app-connections/postgres",
            "integrations/app-connections/terraform-cloud",
-            "integrations/app-connections/vercel"
+            "integrations/app-connections/vercel",
+            "integrations/app-connections/windmill"
          ]
        }
      ]
@@ -447,7 +448,8 @@
            "integrations/secret-syncs/github",
            "integrations/secret-syncs/humanitec",
            "integrations/secret-syncs/terraform-cloud",
-            "integrations/secret-syncs/vercel"
+            "integrations/secret-syncs/vercel",
+            "integrations/secret-syncs/windmill"
          ]
        }
      ]
@@ -1031,6 +1033,18 @@
                "api-reference/endpoints/app-connections/vercel/update",
                "api-reference/endpoints/app-connections/vercel/delete"
              ]
+            },
+            {
+              "group": "Windmill",
+              "pages": [
+                "api-reference/endpoints/app-connections/windmill/list",
+                "api-reference/endpoints/app-connections/windmill/available",
+                "api-reference/endpoints/app-connections/windmill/get-by-id",
+                "api-reference/endpoints/app-connections/windmill/get-by-name",
+                "api-reference/endpoints/app-connections/windmill/create",
+                "api-reference/endpoints/app-connections/windmill/update",
+                "api-reference/endpoints/app-connections/windmill/delete"
+              ]
            }
          ]
        },
@@ -1184,8 +1198,22 @@
                "api-reference/endpoints/secret-syncs/vercel/update",
                "api-reference/endpoints/secret-syncs/vercel/delete",
                "api-reference/endpoints/secret-syncs/vercel/sync-secrets",
-                "api-reference/endpoints/secret-syncs/vercel/remove-secrets",
-                "api-reference/endpoints/secret-syncs/vercel/import-secrets"
+                "api-reference/endpoints/secret-syncs/vercel/import-secrets",
+                "api-reference/endpoints/secret-syncs/vercel/remove-secrets"
+              ]
+            },
+            {
+              "group": "Windmill",
+              "pages": [
+                "api-reference/endpoints/secret-syncs/windmill/list",
+                "api-reference/endpoints/secret-syncs/windmill/get-by-id",
+                "api-reference/endpoints/secret-syncs/windmill/get-by-name",
+                "api-reference/endpoints/secret-syncs/windmill/create",
+                "api-reference/endpoints/secret-syncs/windmill/update",
+                "api-reference/endpoints/secret-syncs/windmill/delete",
+                "api-reference/endpoints/secret-syncs/windmill/sync-secrets",
+                "api-reference/endpoints/secret-syncs/windmill/import-secrets",
+                "api-reference/endpoints/secret-syncs/windmill/remove-secrets"
              ]
            }
          ]