Fly.io secret sync & app connection docs

2026-09-22 13:39:35 +00:00 · 2025-06-16 16:26:54 -04:00
parent fe75627ab7
commit 2aeb02b74a
32 changed files with 350 additions and 0 deletions
--- a/docs/api-reference/endpoints/app-connections/flyio/available.mdx
+++ b/docs/api-reference/endpoints/app-connections/flyio/available.mdx
@@ -0,0 +1,4 @@
+---
+title: "Available"
+openapi: "GET /api/v1/app-connections/flyio/available"
+---
--- a/docs/api-reference/endpoints/app-connections/flyio/create.mdx
+++ b/docs/api-reference/endpoints/app-connections/flyio/create.mdx
@@ -0,0 +1,8 @@
+---
+title: "Create"
+openapi: "POST /api/v1/app-connections/flyio"
+---
+
+<Note>
+    Check out the configuration docs for [Fly.io Connections](/integrations/app-connections/flyio) to learn how to obtain the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/app-connections/flyio/delete.mdx
+++ b/docs/api-reference/endpoints/app-connections/flyio/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/app-connections/flyio/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/flyio/get-by-id.mdx
+++ b/docs/api-reference/endpoints/app-connections/flyio/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/app-connections/flyio/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/flyio/get-by-name.mdx
+++ b/docs/api-reference/endpoints/app-connections/flyio/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/app-connections/flyio/connection-name/{connectionName}"
+---
--- a/docs/api-reference/endpoints/app-connections/flyio/list.mdx
+++ b/docs/api-reference/endpoints/app-connections/flyio/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/app-connections/flyio"
+---
--- a/docs/api-reference/endpoints/app-connections/flyio/update.mdx
+++ b/docs/api-reference/endpoints/app-connections/flyio/update.mdx
@@ -0,0 +1,8 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/app-connections/flyio/{connectionId}"
+---
+
+<Note>
+    Check out the configuration docs for [Fly.io Connections](/integrations/app-connections/flyio) to learn how to obtain the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/secret-syncs/flyio/create.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/flyio/create.mdx
@@ -0,0 +1,4 @@
+---
+title: "Create"
+openapi: "POST /api/v1/secret-syncs/flyio"
+---
--- a/docs/api-reference/endpoints/secret-syncs/flyio/delete.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/flyio/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/secret-syncs/flyio/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/flyio/get-by-id.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/flyio/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/secret-syncs/flyio/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/flyio/get-by-name.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/flyio/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/secret-syncs/flyio/sync-name/{syncName}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/flyio/import-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/flyio/import-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Import Secrets"
+openapi: "POST /api/v1/secret-syncs/flyio/{syncId}/import-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/flyio/list.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/flyio/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/secret-syncs/flyio"
+---
--- a/docs/api-reference/endpoints/secret-syncs/flyio/remove-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/flyio/remove-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Remove Secrets"
+openapi: "POST /api/v1/secret-syncs/flyio/{syncId}/remove-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/flyio/sync-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/flyio/sync-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Sync Secrets"
+openapi: "POST /api/v1/secret-syncs/flyio/{syncId}/sync-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/flyio/update.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/flyio/update.mdx
@@ -0,0 +1,4 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/secret-syncs/flyio/{syncId}"
+---
--- a/docs/images/app-connections/flyio/app-connection-created.png
+++ b/docs/images/app-connections/flyio/app-connection-created.png
--- a/docs/images/app-connections/flyio/app-connection-modal.png
+++ b/docs/images/app-connections/flyio/app-connection-modal.png
--- a/docs/images/app-connections/flyio/app-connection-option.png
+++ b/docs/images/app-connections/flyio/app-connection-option.png
--- a/docs/images/app-connections/flyio/create-token-page.png
+++ b/docs/images/app-connections/flyio/create-token-page.png
--- a/docs/images/app-connections/flyio/create-token.png
+++ b/docs/images/app-connections/flyio/create-token.png
--- a/docs/images/app-connections/flyio/dashboard-page.png
+++ b/docs/images/app-connections/flyio/dashboard-page.png
--- a/docs/images/secret-syncs/flyio/configure-destination.png
+++ b/docs/images/secret-syncs/flyio/configure-destination.png
--- a/docs/images/secret-syncs/flyio/configure-details.png
+++ b/docs/images/secret-syncs/flyio/configure-details.png
--- a/docs/images/secret-syncs/flyio/configure-source.png
+++ b/docs/images/secret-syncs/flyio/configure-source.png
--- a/docs/images/secret-syncs/flyio/configure-sync-options.png
+++ b/docs/images/secret-syncs/flyio/configure-sync-options.png
--- a/docs/images/secret-syncs/flyio/review-configuration.png
+++ b/docs/images/secret-syncs/flyio/review-configuration.png
--- a/docs/images/secret-syncs/flyio/select-option.png
+++ b/docs/images/secret-syncs/flyio/select-option.png
--- a/docs/images/secret-syncs/flyio/sync-created.png
+++ b/docs/images/secret-syncs/flyio/sync-created.png
--- a/docs/integrations/app-connections/flyio.mdx
+++ b/docs/integrations/app-connections/flyio.mdx
@@ -0,0 +1,96 @@
+---
+title: "Fly.io Connection"
+description: "Learn how to configure a Fly.io Connection for Infisical."
+---
+
+Infisical supports the use of [Access Tokens](https://fly.io/docs/security/tokens/) to connect with Fly.io.
+
+## Create Fly.io Access Token
+
+<Steps>
+    <Step title="Navigate to 'Access Tokens'">
+        ![Dashboard Page](/images/app-connections/flyio/dashboard-page.png)
+    </Step>
+    <Step title="Click 'Create Token'">
+        ![Click Create Token](/images/app-connections/flyio/create-token.png)
+    </Step>
+    <Step title="Provide Token Information">
+        Ensure that you give this token access to the correct app, then click 'Create Token'.
+
+        ![Create Token Page](/images/app-connections/flyio/create-token-page.png)
+    </Step>
+    <Step title="Save Token">
+        After clicking 'Create Token', a modal containing your access token will appear. Save this token for later steps.
+    </Step>
+</Steps>
+
+## Create Fly.io 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**](https://app.infisical.com/organization/app-connections) tab.
+
+                ![App Connections Tab](/images/app-connections/general/add-connection.png)
+            </Step>
+            <Step title="Select Fly.io Connection">
+                Click the **+ Add Connection** button and select the **Fly.io Connection** option from the available integrations.
+
+                ![Select Fly.io Connection](/images/app-connections/flyio/app-connection-option.png)
+            </Step>
+            <Step title="Fill out the Fly.io Connection Modal">
+                Complete the Fly.io Connection form by entering:
+                - A descriptive name for the connection
+                - An optional description for future reference
+                - The Access Token from earlier steps
+
+                ![Fly.io Connection Modal](/images/app-connections/flyio/app-connection-modal.png)
+            </Step>
+            <Step title="Connection Created">
+                After clicking Create, your **Fly.io Connection** is established and ready to use with your Infisical projects.
+
+                ![Fly.io Connection Created](/images/app-connections/flyio/app-connection-created.png)
+            </Step>
+        </Steps>
+    </Tab>
+    <Tab title="API">
+        To create an Fly.io Connection, make an API request to the [Create Fly.io Connection](/api-reference/endpoints/app-connections/flyio/create) API endpoint.
+
+        ### Sample request
+
+        ```bash Request
+        curl    --request POST \
+                --url https://app.infisical.com/api/v1/app-connections/flyio \
+                --header 'Content-Type: application/json' \
+                --data '{
+                    "name": "my-flyio-connection",
+                    "method": "access-token",
+                    "credentials": {
+                        "accessToken": "[PRIVATE TOKEN]"
+                    }
+                }'
+        ```
+
+        ### Sample response
+
+        ```bash Response
+        {
+          "appConnection": {
+              "id": "e5d18aca-86f7-4026-a95e-efb8aeb0d8e6",
+              "name": "my-flyio-connection",
+              "description": null,
+              "version": 1,
+              "orgId": "6f03caa1-a5de-43ce-b127-95a145d3464c",
+              "createdAt": "2025-04-23T19:46:34.831Z",
+              "updatedAt": "2025-04-23T19:46:34.831Z",
+              "isPlatformManagedCredentials": false,
+              "credentialsHash": "7c2d371dec195f82a6a0d5b41c970a229cfcaf88e894a5b6395e2dbd0280661f",
+              "app": "flyio",
+              "method": "access-token",
+              "credentials": {}
+          }
+        }
+        ```
+    </Tab>
+</Tabs>
--- a/docs/integrations/secret-syncs/flyio.mdx
+++ b/docs/integrations/secret-syncs/flyio.mdx
@@ -0,0 +1,155 @@
+---
+title: "Fly.io Sync"
+description: "Learn how to configure a Fly.io Sync for Infisical."
+---
+
+**Prerequisites:**
+- Create an [Fly.io Connection](/integrations/app-connections/flyio)
+
+<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 'Fly.io'">
+                ![Select Fly.io](/images/secret-syncs/flyio/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/flyio/configure-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/flyio/configure-destination.png)
+
+                - **Fly.io Connection**: The Fly.io Connection to authenticate with.
+                - **App**: The Fly.io app to sync secrets to.
+            </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/flyio/configure-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.
+                    <Note>
+                        Fly.io does not support importing secrets.
+                    </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 Fly.io Sync, then click **Next**.
+
+                ![Configure Details](/images/secret-syncs/flyio/configure-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 Fly.io Sync configuration, then click **Create Sync**.
+
+                ![Review Configuration](/images/secret-syncs/flyio/review-configuration.png)
+            </Step>
+            <Step title="Sync created">
+                If enabled, your Fly.io Sync will begin syncing your secrets to the destination endpoint.
+
+                ![Sync Created](/images/secret-syncs/flyio/sync-created.png)
+            </Step>
+        </Steps>
+    </Tab>
+    <Tab title="API">
+        To create an **Fly.io Sync**, make an API request to the [Create Fly.io Sync](/api-reference/endpoints/secret-syncs/flyio/create) API endpoint.
+
+        ### Sample request
+
+        ```bash Request
+        curl    --request POST \
+                --url https://app.infisical.com/api/v1/secret-syncs/flyio \
+                --header 'Content-Type: application/json' \
+                --data '{
+                    "name": "my-flyio-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": {
+                        "appId": "..."
+                    }
+                }'
+        ```
+
+        ### Sample response
+
+        ```bash Response
+        {
+            "secretSync": {
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "name": "my-flyio-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": "flyio",
+                    "name": "my-flyio-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": "flyio",
+                "destinationConfig": {
+                  "appId": "..."
+                }
+            }
+        }
+        ```
+    </Tab>
+</Tabs>
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -503,6 +503,7 @@
            "integrations/app-connections/azure-key-vault",
            "integrations/app-connections/camunda",
            "integrations/app-connections/databricks",
+            "integrations/app-connections/flyio",
            "integrations/app-connections/gcp",
            "integrations/app-connections/github",
            "integrations/app-connections/github-radar",
@@ -537,6 +538,7 @@
            "integrations/secret-syncs/azure-key-vault",
            "integrations/secret-syncs/camunda",
            "integrations/secret-syncs/databricks",
+            "integrations/secret-syncs/flyio",
            "integrations/secret-syncs/gcp-secret-manager",
            "integrations/secret-syncs/github",
            "integrations/secret-syncs/hashicorp-vault",
@@ -1262,6 +1264,18 @@
                "api-reference/endpoints/app-connections/databricks/delete"
              ]
            },
+            {
+              "group": "Fly.io",
+              "pages": [
+                "api-reference/endpoints/app-connections/flyio/list",
+                "api-reference/endpoints/app-connections/flyio/available",
+                "api-reference/endpoints/app-connections/flyio/get-by-id",
+                "api-reference/endpoints/app-connections/flyio/get-by-name",
+                "api-reference/endpoints/app-connections/flyio/create",
+                "api-reference/endpoints/app-connections/flyio/update",
+                "api-reference/endpoints/app-connections/flyio/delete"
+              ]
+            },
            {
              "group": "GCP",
              "pages": [
@@ -1559,6 +1573,19 @@
                "api-reference/endpoints/secret-syncs/databricks/remove-secrets"
              ]
            },
+            {
+              "group": "Fly.io",
+              "pages": [
+                "api-reference/endpoints/secret-syncs/flyio/list",
+                "api-reference/endpoints/secret-syncs/flyio/get-by-id",
+                "api-reference/endpoints/secret-syncs/flyio/get-by-name",
+                "api-reference/endpoints/secret-syncs/flyio/create",
+                "api-reference/endpoints/secret-syncs/flyio/update",
+                "api-reference/endpoints/secret-syncs/flyio/delete",
+                "api-reference/endpoints/secret-syncs/flyio/sync-secrets",
+                "api-reference/endpoints/secret-syncs/flyio/remove-secrets"
+              ]
+            },
            {
              "group": "GCP Secret Manager",
              "pages": [