ENG-2595 (#3976)

* feat: implement railway secret sync * fix: railway sync config * feat: add documentation on railway * fix: undo mock on-prem change * lint: fix * fix: cleanup railway integration * fix: retry and doc images * fix: sync fields * fix: query typo * Update docs/docs.json Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
2026-10-07 11:27:32 +00:00 · 2025-07-10 22:53:18 +05:30
parent d3d1fb7190
commit fedffea8d5
98 changed files with 1931 additions and 98 deletions
@@ -0,0 +1,4 @@
+---
+title: "Available"
+openapi: "GET /api/v1/app-connections/railway/available"
+---
@@ -0,0 +1,8 @@
+---
+title: "Create"
+openapi: "POST /api/v1/app-connections/railway"
+---
+
+<Note>
+    Check out the configuration docs for [Railway Connections](/integrations/app-connections/railway) to learn how to obtain the required credentials.
+</Note>
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/app-connections/railway/{connectionId}"
+---
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/app-connections/railway/{connectionId}"
+---
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/app-connections/railway/connection-name/{connectionName}"
+---
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/app-connections/railway"
+---
@@ -0,0 +1,8 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/app-connections/railway/{connectionId}"
+---
+
+<Note>
+    Check out the configuration docs for [Railway Connections](/integrations/app-connections/railway) to learn how to obtain the required credentials.
+</Note>
@@ -0,0 +1,4 @@
+---
+title: "Create"
+openapi: "POST /api/v1/secret-syncs/railway"
+---
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/secret-syncs/railway/{syncId}"
+---
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/secret-syncs/railway/{syncId}"
+---
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/secret-syncs/railway/sync-name/{syncName}"
+---
@@ -0,0 +1,4 @@
+---
+title: "Import Secrets"
+openapi: "POST /api/v1/secret-syncs/railway/{syncId}/import-secrets"
+---
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/secret-syncs/railway"
+---
@@ -0,0 +1,4 @@
+---
+title: "Remove Secrets"
+openapi: "POST /api/v1/secret-syncs/railway/{syncId}/remove-secrets"
+---
@@ -0,0 +1,4 @@
+---
+title: "Sync Secrets"
+openapi: "POST /api/v1/secret-syncs/railway/{syncId}/sync-secrets"
+---
@@ -0,0 +1,4 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/secret-syncs/railway/{syncId}"
+---
@@ -78,10 +78,7 @@
              },
              {
                "group": "Infisical SSH",
-                "pages": [
-                  "documentation/platform/ssh/overview",
-                  "documentation/platform/ssh/host-groups"
-                ]
+                "pages": ["documentation/platform/ssh/overview", "documentation/platform/ssh/host-groups"]
              },
              {
                "group": "Key Management (KMS)",
@@ -378,10 +375,7 @@
              },
              {
                "group": "Architecture",
-                "pages": [
-                  "internals/architecture/components",
-                  "internals/architecture/cloud"
-                ]
+                "pages": ["internals/architecture/components", "internals/architecture/cloud"]
              },
              "internals/security",
              "internals/service-tokens"
@@ -488,6 +482,7 @@
                  "integrations/app-connections/oci",
                  "integrations/app-connections/oracledb",
                  "integrations/app-connections/postgres",
+                  "integrations/app-connections/railway",
                  "integrations/app-connections/render",
                  "integrations/app-connections/teamcity",
                  "integrations/app-connections/terraform-cloud",
@@ -522,6 +517,7 @@
                  "integrations/secret-syncs/heroku",
                  "integrations/secret-syncs/humanitec",
                  "integrations/secret-syncs/oci-vault",
+                  "integrations/secret-syncs/railway",
                  "integrations/secret-syncs/render",
                  "integrations/secret-syncs/teamcity",
                  "integrations/secret-syncs/terraform-cloud",
@@ -550,10 +546,7 @@
              "integrations/cloud/gcp-secret-manager",
              {
                "group": "Cloudflare",
-                "pages": [
-                  "integrations/cloud/cloudflare-pages",
-                  "integrations/cloud/cloudflare-workers"
-                ]
+                "pages": ["integrations/cloud/cloudflare-pages", "integrations/cloud/cloudflare-workers"]
              },
              "integrations/cloud/terraform-cloud",
              "integrations/cloud/databricks",
@@ -563,8 +556,8 @@
                  "integrations/cloud/digital-ocean-app-platform",
                  "integrations/cloud/heroku",
                  "integrations/cloud/netlify",
-                  "integrations/cloud/railway",
                  "integrations/cloud/flyio",
+                  "integrations/cloud/railway",
                  "integrations/cloud/render",
                  "integrations/cloud/laravel-forge",
                  "integrations/cloud/supabase",
@@ -665,11 +658,7 @@
                  "cli/commands/reset",
                  {
                    "group": "infisical scan",
-                    "pages": [
-                      "cli/commands/scan",
-                      "cli/commands/scan-git-changes",
-                      "cli/commands/scan-install"
-                    ]
+                    "pages": ["cli/commands/scan", "cli/commands/scan-git-changes", "cli/commands/scan-install"]
                  }
                ]
              },
@@ -853,30 +842,30 @@
              {
                "group": "Organizations",
                "pages": [
-                {
-                  "group": "OIDC SSO",
-                  "pages": [
-                    "api-reference/endpoints/organizations/oidc-sso/get-oidc-config",
-                    "api-reference/endpoints/organizations/oidc-sso/update-oidc-config",
-                    "api-reference/endpoints/organizations/oidc-sso/create-oidc-config"
-                  ]
-                },
-                {
-                  "group": "LDAP SSO",
-                  "pages": [
-                    "api-reference/endpoints/organizations/ldap-sso/get-ldap-config",
-                    "api-reference/endpoints/organizations/ldap-sso/update-ldap-config",
-                    "api-reference/endpoints/organizations/ldap-sso/create-ldap-config"
-                  ]
-                },
-                {
-                  "group": "SAML SSO",
-                  "pages": [
-                    "api-reference/endpoints/organizations/saml-sso/get-saml-config",
-                    "api-reference/endpoints/organizations/saml-sso/update-saml-config",
-                    "api-reference/endpoints/organizations/saml-sso/create-saml-config"
-                  ]
-                },
+                  {
+                    "group": "OIDC SSO",
+                    "pages": [
+                      "api-reference/endpoints/organizations/oidc-sso/get-oidc-config",
+                      "api-reference/endpoints/organizations/oidc-sso/update-oidc-config",
+                      "api-reference/endpoints/organizations/oidc-sso/create-oidc-config"
+                    ]
+                  },
+                  {
+                    "group": "LDAP SSO",
+                    "pages": [
+                      "api-reference/endpoints/organizations/ldap-sso/get-ldap-config",
+                      "api-reference/endpoints/organizations/ldap-sso/update-ldap-config",
+                      "api-reference/endpoints/organizations/ldap-sso/create-ldap-config"
+                    ]
+                  },
+                  {
+                    "group": "SAML SSO",
+                    "pages": [
+                      "api-reference/endpoints/organizations/saml-sso/get-saml-config",
+                      "api-reference/endpoints/organizations/saml-sso/update-saml-config",
+                      "api-reference/endpoints/organizations/saml-sso/create-saml-config"
+                    ]
+                  },
                  "api-reference/endpoints/organizations/memberships",
                  "api-reference/endpoints/organizations/update-membership",
                  "api-reference/endpoints/organizations/delete-membership",
@@ -993,9 +982,7 @@
                "pages": [
                  {
                    "group": "Kubernetes",
-                    "pages": [
-                      "api-reference/endpoints/dynamic-secrets/kubernetes/create-lease"
-                    ]
+                    "pages": ["api-reference/endpoints/dynamic-secrets/kubernetes/create-lease"]
                  },
                  "api-reference/endpoints/dynamic-secrets/create",
                  "api-reference/endpoints/dynamic-secrets/update",
@@ -1517,6 +1504,18 @@
                      "api-reference/endpoints/app-connections/postgres/delete"
                    ]
                  },
+                  {
+                    "group": "Railway",
+                    "pages": [
+                      "api-reference/endpoints/app-connections/railway/list",
+                      "api-reference/endpoints/app-connections/railway/available",
+                      "api-reference/endpoints/app-connections/railway/get-by-id",
+                      "api-reference/endpoints/app-connections/railway/get-by-name",
+                      "api-reference/endpoints/app-connections/railway/create",
+                      "api-reference/endpoints/app-connections/railway/update",
+                      "api-reference/endpoints/app-connections/railway/delete"
+                    ]
+                  },
                  {
                    "group": "Render",
                    "pages": [
@@ -1826,6 +1825,20 @@
                      "api-reference/endpoints/secret-syncs/oci-vault/remove-secrets"
                    ]
                  },
+                  {
+                    "group": "Railway",
+                    "pages": [
+                      "api-reference/endpoints/secret-syncs/railway/list",
+                      "api-reference/endpoints/secret-syncs/railway/get-by-id",
+                      "api-reference/endpoints/secret-syncs/railway/get-by-name",
+                      "api-reference/endpoints/secret-syncs/railway/create",
+                      "api-reference/endpoints/secret-syncs/railway/update",
+                      "api-reference/endpoints/secret-syncs/railway/delete",
+                      "api-reference/endpoints/secret-syncs/railway/sync-secrets",
+                      "api-reference/endpoints/secret-syncs/railway/import-secrets",
+                      "api-reference/endpoints/secret-syncs/railway/remove-secrets"
+                    ]
+                  },
                  {
                    "group": "Render",
                    "pages": [
@@ -2172,7 +2185,7 @@
  "api": {
    "openapi": "https://app.infisical.com/api/docs/json",
    "mdx": {
-      "server": ["https://app.infisical.com", "http://localhost:8080"]
+      "server": ["https://app.infisical.com"]
    }
  },
  "appearance": {
@@ -0,0 +1,164 @@
+---
+title: "Railway Connection"
+description: "Learn how to configure a Railway Connection for Infisical."
+---
+
+Infisical supports the use of [API Tokens](https://docs.railway.com/guides/public-api#creating-a-token) to connect with Railway.
+
+## Create a Railway API Token
+
+<Tabs>
+  <Tab title="Team Token">
+    A team token provides access to all resources within a team. It cannot be used to access personal resources in Railway.
+
+    <Steps>
+      <Step title="Click the profile image in the top-right corner and select 'Account Settings'">
+        ![Dashboard Page](/images/app-connections/railway/railway-app-connection-account-settings.png)
+      </Step>
+      <Step title="In the personal settings sidebar, click on 'Tokens'">
+        ![Account Settings Page](/images/app-connections/railway/railway-app-connection-account-settings-tokens.png)
+      </Step>
+      <Step title="Enter a token name and select a team">
+        Make sure to provide a descriptive name and select the correct team.
+
+        ![Enter Name and Select Team](/images/app-connections/railway/railway-app-connection-team-token-form.png)
+      </Step>
+      <Step title="Click on 'Create'">
+        ![Create Token](/images/app-connections/railway/railway-app-connection-team-token-create.png)
+      </Step>
+      <Step title="Save the token">
+        After clicking 'Create', your access token will be displayed. Save it securely for later use.
+
+        ![Copy Token Modal](/images/app-connections/railway/railway-app-connection-team-token-created.png)
+      </Step>
+    </Steps>
+  </Tab>
+
+  <Tab title="Account Token">
+    If no team is selected, the token will be associated with your personal Railway account and will have access to all your individual and team resources.
+
+    <Steps>
+      <Step title="Click the profile image in the top-right corner and select 'Account Settings'">
+        ![Dashboard Page](/images/app-connections/railway/railway-app-connection-account-settings.png)
+      </Step>
+      <Step title="In the personal settings sidebar, click on 'Tokens'">
+        ![Account Settings Page](/images/app-connections/railway/railway-app-connection-account-settings-tokens.png)
+      </Step>
+      <Step title="Enter a token name and select 'No workspace'">
+        Provide a descriptive name and ensure no team is selected. This will create an account-level token.
+
+        ![Enter Name](/images/app-connections/railway/railway-app-connection-account-token-form.png)
+      </Step>
+      <Step title="Click on 'Create'">
+        ![Create Token](/images/app-connections/railway/railway-app-connection-account-token-create.png)
+      </Step>
+      <Step title="Save the token">
+        After clicking 'Create', your access token will be shown. Save it for future use.
+
+        ![Copy Token Modal](/images/app-connections/railway/railway-app-connection-account-token-created.png)
+      </Step>
+    </Steps>
+  </Tab>
+
+  <Tab title="Project Token">
+    Project tokens are limited to a specific environment within a project and can only be used to authenticate requests to that environment.
+
+    <Steps>
+      <Step title="Open your Railway dashboard and click on a project">
+        ![Dashboard Page](/images/app-connections/railway/railway-app-connection-project-token-dashboard.png)
+      </Step>
+      <Step title="On the project page, click 'Settings' in the top-right corner">
+        ![Project Settings Page](/images/app-connections/railway/railway-app-connection-project-token-project.png)
+      </Step>
+      <Step title="In the left sidebar, scroll to the bottom and click on 'Tokens'">
+        ![Project Token Settings Page](/images/app-connections/railway/railway-app-connection-project-token-settings.png)
+      </Step>
+      <Step title="Enter a token name and select an environment">
+        Provide a descriptive name and select the appropriate environment for the token.
+
+        ![Enter Name and Select environment](/images/app-connections/railway/railway-app-connection-project-token-form.png)
+      </Step>
+      <Step title="Click on 'Create'">
+        ![Create Token](/images/app-connections/railway/railway-app-connection-project-token-create.png)
+      </Step>
+      <Step title="Save the token">
+        After clicking 'Create', the access token will be displayed. Be sure to save it for later use.
+
+        ![Copy Token Modal](/images/app-connections/railway/railway-app-connection-project-token-created.png)
+      </Step>
+    </Steps>
+  </Tab>
+</Tabs>
+
+## Create a Railway 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 Railway Connection">
+        Click **+ Add Connection** and choose **Railway Connection** from the list of integrations.
+
+        ![Select Railway Connection](/images/app-connections/railway/railway-app-connection-option.png)
+      </Step>
+      <Step title="Fill out the Railway Connection form">
+        Complete the form by providing:
+        - A descriptive name for the connection
+        - An optional description
+        - The type of token you created earlier
+        - The token value from the previous step
+
+        ![Railway Connection Modal](/images/app-connections/railway/railway-app-connection-form.png)
+      </Step>
+      <Step title="Connection created">
+        After submitting the form, your **Railway Connection** will be successfully created and ready to use with your Infisical projects.
+
+        ![Railway Connection Created](/images/app-connections/railway/railway-app-connection-generated.png)
+      </Step>
+    </Steps>
+  </Tab>
+
+  <Tab title="API">
+    To create a Railway Connection via API, send a request to the [Create Railway Connection](/api-reference/endpoints/app-connections/railway/create) endpoint.
+
+    ### Sample request
+
+    ```bash Request
+    curl    --request POST \
+            --url https://app.infisical.com/api/v1/app-connections/railway \
+            --header 'Content-Type: application/json' \
+            --data '{
+                "name": "my-railway-connection",
+                "method": "team-token",
+                "credentials": {
+                    "apiToken": "[TEAM TOKEN]"
+                }
+            }'
+    ```
+
+    ### Sample response
+
+    ```bash Response
+    {
+      "appConnection": {
+          "id": "e5d18aca-86f7-4026-a95e-efb8aeb0d8e6",
+          "name": "my-railway-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": "railway",
+          "method": "team-token",
+          "credentials": {}
+      }
+    }
+    ```
+  </Tab>
+</Tabs>
@@ -0,0 +1,171 @@
+---
+title: "Railway Sync"
+description: "Learn how to configure a Railway Sync for Infisical."
+---
+
+**Prerequisites:**
+- Create a [Railway Connection](/integrations/app-connections/railway)
+
+<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 'Railway'">
+                ![Select Railway](/images/secret-syncs/railway/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/railway/railway-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/railway/railway-sync-destination.png)
+
+                - **Railway Connection**: The Railway Connection to authenticate with.
+                - **Project**: The Railway project to sync secrets to.
+                - **Environment**: The Railway environment to sync secrets to.
+                - **Service**: The Service to sync secrets to.
+                    - **If not provided**: Secrets will be synced as [shared variables](https://docs.railway.com/guides/variables#shared-variables) on Railway.
+            </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/railway/railway-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 Railway when keys conflict.
+                    - **Import Secrets (Prioritize Railway)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Railway 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.
+                <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 Railway Sync, then click **Next**.
+
+                ![Configure Details](/images/secret-syncs/railway/railway-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 Railway Sync configuration, then click **Create Sync**.
+
+                ![Review Configuration](/images/secret-syncs/railway/railway-sync-review.png)
+            </Step>
+            <Step title="Sync created">
+                If enabled, your Railway Sync will begin syncing your secrets to the destination endpoint.
+
+                ![Sync Created](/images/secret-syncs/railway/railway-sync-created.png)
+            </Step>
+        </Steps>
+    </Tab>
+    <Tab title="API">
+        To create a **Railway Sync**, make an API request to the [Create Railway Sync](/api-reference/endpoints/secret-syncs/railway/create) API endpoint.
+
+        ### Sample request
+
+        ```bash Request
+        curl    --request POST \
+                --url https://app.infisical.com/api/v1/secret-syncs/railway \
+                --header 'Content-Type: application/json' \
+                --data '{
+                    "name": "my-railway-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",
+                        "autoSyncEnabled": true,
+                        "disableSecretDeletion": false
+                    },
+                    "destinationConfig": {
+                        "projectId": "dev-project-id",
+                        "projectName": "Development Project",
+                        "environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                        "environmentName": "Development",
+                        "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                        "serviceName": "my-railway-service",
+                    }
+                }'
+        ```
+
+        ### Sample response
+
+        ```bash Response
+        {
+            "secretSync": {
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "name": "my-railway-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",
+                    "autoSyncEnabled": true,
+                    "disableSecretDeletion": false
+                },
+                "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "connection": {
+                    "app": "railway",
+                    "name": "my-railway-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": "railway",
+                "destinationConfig": {
+                    "projectId": "dev-project-id",
+                    "projectName": "Development Project",
+                    "environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                    "environmentName": "Development",
+                    "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                    "serviceName": "my-railway-service",
+                }
+            }
+        }
+        ```
+    </Tab>
+</Tabs>