Railway Sync

Prerequisites:

Create a Railway Connection

Navigate to Project > Integrations and select the Secret Syncs tab. Click on the Add Sync button.

Secret Syncs Tab

Select Railway

Configure the Source from where secrets should be retrieved, then click Next.

Configure Source

Environment: The project environment to retrieve secrets from.
Secret Path: The folder path to retrieve secrets from.

If you need to sync secrets from multiple folder locations, check out secret imports.

Configure the Destination to where secrets should be deployed, then click Next.

Configure Destination

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 on Railway.

Configure the Sync Options to specify how secrets should be synced, then click Next.

Configure Options

Initial Sync Behavior: Determines how Hanzo KMS should resolve the initial sync.
- Overwrite Destination Secrets: Removes any secrets at the destination endpoint not present in Hanzo KMS.
- Import Secrets (Prioritize Hanzo KMS): Imports secrets from the destination endpoint before syncing, prioritizing values from Hanzo KMS over Railway when keys conflict.
- Import Secrets (Prioritize Railway): Imports secrets from the destination endpoint before syncing, prioritizing values from Railway over Hanzo KMS 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.

We highly recommend using a Key Schema to ensure that Hanzo KMS only manages the specific keys you intend, keeping everything else untouched.

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, Hanzo KMS will not remove secrets from the sync destination. Enable this option if you intend to manage some secrets manually outside of Hanzo KMS.

Configure the Details of your Railway Sync, then click Next.

Configure Details

Name: The name of your sync. Must be slug-friendly.
Description: An optional description for your sync.

Review your Railway Sync configuration, then click Create Sync.

Review Configuration

If enabled, your Railway Sync will begin syncing your secrets to the destination endpoint.

Sync Created

To create a Railway Sync, make an API request to the Create Railway Sync API endpoint.

Sample request

curl    --request POST \
        --url https://app.kms.hanzo.ai/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

{
    "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",
        }
    }
}

Sample request

Sample response

On this page