Railway

Manage Railway projects, deployments, and variables

Railway is a cloud application platform for deploying, operating, and scaling services, databases, jobs, and production environments from a single project workspace. Teams use Railway to connect source repositories, manage environments, configure variables, trigger deployments, and monitor delivery across staging and production.

With Railway, you can:

  • Manage projects and environments: Organize deployed services and inspect the environments attached to each project
  • Automate deployments: Trigger new service deployments and inspect recent deployment status from workflows
  • Control runtime configuration: Read and update environment variables for services or shared project environments
  • Connect infrastructure workflows: Use project, service, and environment IDs from one step to drive release automation in later steps

In Sim, the Railway integration lets your agents work with Railway's public GraphQL API directly from workflows. You can list projects, fetch project services and environments, inspect deployments, deploy a service, and manage environment variables as part of CI/CD, operations, and release processes.

Usage Instructions

Integrate Railway into workflows to list projects, inspect services and environments, monitor deployments, trigger service deployments, and manage environment variables.

Tools

railway_list_projects

List Railway projects visible to the provided token

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
workspaceIdstringNoWorkspace ID to list projects from
firstnumberNoMaximum number of projects to return
afterstringNoCursor for pagination

Output

ParameterTypeDescription
projectsarrayRailway projects
idstringProject ID
namestringProject name
descriptionstringProject description
createdAtstringProject creation timestamp
updatedAtstringProject update timestamp
pageInfoobjectPagination information
hasNextPagebooleanWhether more projects are available
endCursorstringCursor for the next page
countnumberNumber of projects returned

railway_get_project

Get a Railway project with its services and environments

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
projectIdstringYesRailway project ID

Output

ParameterTypeDescription
projectobjectProject with services and environments
idstringProject ID
namestringProject name
descriptionstringProject description
createdAtstringProject creation timestamp
servicesarrayProject services
idstringService ID
namestringService name
iconstringService icon
environmentsarrayProject environments
idstringEnvironment ID
namestringEnvironment name

railway_create_project

Create a Railway project

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
namestringYesProject name
descriptionstringNoProject description
workspaceIdstringNoWorkspace ID to create the project in
isPublicbooleanNoWhether the project should be publicly visible
defaultEnvironmentNamestringNoName for the default environment
prDeploysbooleanNoWhether to enable pull request deploys

Output

ParameterTypeDescription
projectobjectCreated project
idstringProject ID
namestringProject name

railway_update_project

Update a Railway project name or description

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
projectIdstringYesRailway project ID
namestringNoUpdated project name
descriptionstringNoUpdated project description
isPublicbooleanNoWhether the project should be publicly visible
prDeploysbooleanNoWhether to enable pull request deploy environments

Output

ParameterTypeDescription
projectobjectUpdated project
idstringProject ID
namestringProject name
descriptionstringProject description

railway_delete_project

Delete a Railway project

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
projectIdstringYesRailway project ID

Output

ParameterTypeDescription
successbooleanWhether the project was deleted

railway_transfer_project

Transfer a Railway project to another workspace

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
projectIdstringYesRailway project ID
workspaceIdstringYesDestination workspace ID

Output

ParameterTypeDescription
successbooleanWhether the project was transferred

railway_list_project_members

List members for a Railway project

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
projectIdstringYesRailway project ID

Output

ParameterTypeDescription
membersarrayProject members
idstringProject membership ID
rolestringProject role
userobjectRailway user
idstringUser ID
namestringUser name
emailstringUser email
countnumberNumber of members returned

railway_create_environment

Create a Railway project environment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
projectIdstringYesRailway project ID
namestringYesEnvironment name
sourceEnvironmentIdstringNoEnvironment ID to clone from
ephemeralbooleanNoWhether the environment is ephemeral
skipInitialDeploysbooleanNoWhether to skip initial deploys for the environment
stageInitialChangesbooleanNoWhether to stage initial changes instead of applying them immediately

Output

ParameterTypeDescription
environmentobjectCreated environment
idstringEnvironment ID
namestringEnvironment name

railway_delete_environment

Delete a Railway project environment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
environmentIdstringYesRailway environment ID

Output

ParameterTypeDescription
successbooleanWhether the environment was deleted

railway_list_deployments

List deployments for a Railway service in an environment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
projectIdstringYesRailway project ID
serviceIdstringYesRailway service ID
environmentIdstringYesRailway environment ID
firstnumberNoMaximum number of deployments to return
afterstringNoCursor for pagination

Output

ParameterTypeDescription
deploymentsarrayService deployments
idstringDeployment ID
statusstringDeployment status
createdAtstringDeployment creation timestamp
urlstringDeployment URL
staticUrlstringStatic deployment URL
countnumberNumber of deployments returned
pageInfoobjectPagination information
hasNextPagebooleanWhether more deployments are available
endCursorstringCursor for the next page

railway_deploy_service

Trigger a deployment for a Railway service in an environment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
serviceIdstringYesRailway service ID
environmentIdstringYesRailway environment ID
commitShastringNoSpecific Git commit SHA to deploy

Output

ParameterTypeDescription
deploymentIdstringCreated deployment ID

railway_list_variables

List Railway environment variables for a service or shared environment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
projectIdstringYesRailway project ID
environmentIdstringYesRailway environment ID
serviceIdstringNoRailway service ID. Omit for shared environment variables.

Output

ParameterTypeDescription
variablesobjectVariable names and values
countnumberNumber of variables returned

railway_upsert_variable

Create or update a Railway environment variable

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type: account, workspace, project, or oauth
projectIdstringYesRailway project ID
environmentIdstringYesRailway environment ID
serviceIdstringNoRailway service ID. Omit to create or update a shared variable.
namestringYesVariable name
valuestringYesVariable value
skipDeploysbooleanNoWhether to skip automatic redeploys after changing the variable

Output

ParameterTypeDescription
successbooleanWhether the variable was created or updated

On this page