mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
feature: windmill connection and sync
This commit is contained in:
102
docs/integrations/app-connections/windmill.mdx
Normal file
102
docs/integrations/app-connections/windmill.mdx
Normal file
@@ -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**.
|
||||

|
||||
</Step>
|
||||
<Step title="Access Token Section">
|
||||
In the **Tokens** section on the drawer, click **Create token**.
|
||||

|
||||
</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>
|
||||

|
||||
</Step>
|
||||
<Step title="Copy Access Token">
|
||||
Copy your new access token and save it for the steps below.
|
||||

|
||||
</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.
|
||||

|
||||
</Step>
|
||||
<Step title="Add Connection">
|
||||
Click the **+ Add Connection** button and select the **Windmill Connection** option.
|
||||

|
||||
</Step>
|
||||
<Step title="Configure Connection">
|
||||
Configure your Windmill Connection using the access token generated in the steps above. Then click **Connect to Windmill**.
|
||||

|
||||
|
||||
- **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.
|
||||

|
||||
</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>
|
||||
Reference in New Issue
Block a user