setup

Railway

Purpose

Collects Railway workspaces, projects, services, environments, deployments, domains, TCP proxies, volumes, variables, users, and API tokens.

tip

Secret fields below accept either an AWS Secrets Manager ARN or a value pasted directly into SubImage's managed vault. See Secrets for details.

Required Fields

Field Secret? Description
railway_token Yes Railway account or workspace API token

Optional Fields

Field Description
railway_workspace_id Workspace ID to sync. Required for workspace-scoped tokens.
railway_base_url GraphQL API URL. Defaults to https://backboard.railway.com/graphql/v2.

Setup Steps

  1. Open the Railway account tokens page.
  2. Create an account token to sync every accessible workspace, or create a workspace token and copy the workspace ID from its settings URL.
  3. Do not use a project token. Railway project tokens use a different authentication scheme and are not supported.
  4. In SubImage, enter the token in railway_token.
  5. If you created a workspace token, enter its workspace ID in railway_workspace_id.
  6. Save the module and run a sync.

Notes

Railway applies hourly API limits. Large workspaces may require a higher Railway plan or a narrower workspace selection.