Railway

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, manage services and environments, monitor deployments, trigger and roll back service deployments, and manage environment variables.

Actions

Railway List Projects

List Railway projects visible to the provided token

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
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. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringYesRailway project ID

Output

ParameterTypeDescription
projectobjectProject with services and environments
idstringProject ID
namestringProject name
descriptionstringProject description
createdAtstringProject creation timestamp
updatedAtstringProject update 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. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
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. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
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. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
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. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
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. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringYesRailway project ID

Output

ParameterTypeDescription
membersarrayProject members
idstringMember user ID
rolestringProject role
namestringMember name
emailstringMember email
avatarstringMember avatar URL
countnumberNumber of members returned

Railway Create Environment

Create a Railway project environment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
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. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
environmentIdstringYesRailway environment ID

Output

ParameterTypeDescription
successbooleanWhether the environment was deleted

Railway Create Service

Create a Railway service from a GitHub repo or Docker image

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringYesRailway project ID
namestringYesService name
repostringNoGitHub repository in owner/name format to deploy from
imagestringNoDocker image to deploy, for example redis:7-alpine
branchstringNoGit branch to deploy when using a repository source

Output

ParameterTypeDescription
serviceobjectCreated service
idstringService ID
namestringService name

Railway Delete Service

Delete a Railway service and all of its deployments

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
serviceIdstringYesRailway service ID

Output

ParameterTypeDescription
successbooleanWhether the service was deleted

Railway List Deployments

List deployments for a Railway service in an environment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
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
canRollbackbooleanWhether this deployment can be rolled back to
canRedeploybooleanWhether this deployment can be redeployed
countnumberNumber of deployments returned
pageInfoobjectPagination information
hasNextPagebooleanWhether more deployments are available
endCursorstringCursor for the next page

Railway Get Deployment

Get details for a single Railway deployment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringYesRailway deployment ID

Output

ParameterTypeDescription
deploymentobjectDeployment details
idstringDeployment ID
statusstringDeployment status
createdAtstringDeployment creation timestamp
urlstringDeployment URL
staticUrlstringStatic deployment URL
canRollbackbooleanWhether the deployment can be rolled back to
canRedeploybooleanWhether the deployment can be redeployed

Railway Deploy Service

Trigger a deployment for a Railway service in an environment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
serviceIdstringYesRailway service ID
environmentIdstringYesRailway environment ID
commitShastringNoSpecific Git commit SHA to deploy

Output

ParameterTypeDescription
deploymentIdstringCreated deployment ID

Railway Restart Deployment

Restart a running Railway deployment without rebuilding

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringYesRailway deployment ID

Output

ParameterTypeDescription
successbooleanWhether the deployment was restarted

Railway Rollback Deployment

Roll a Railway service back to a previous deployment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringYesRailway deployment ID to roll back to (must have canRollback)

Output

ParameterTypeDescription
successbooleanWhether the rollback was triggered

Railway Get Deployment Logs

Retrieve runtime logs for a Railway deployment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringYesRailway deployment ID
limitnumberNoMaximum number of log lines to return

Output

ParameterTypeDescription
logsarrayDeployment log entries
timestampstringLog timestamp
messagestringLog message
severitystringLog severity
countnumberNumber of log entries returned

Railway List Variables

List Railway environment variables for a service or shared environment

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
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. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
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

Railway Delete Variable

Delete a Railway environment variable

Input

ParameterTypeRequiredDescription
apiKeystringYesRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringYesRailway project ID
environmentIdstringYesRailway environment ID
namestringYesVariable name to delete
serviceIdstringNoRailway service ID. Omit to delete a shared variable.

Output

ParameterTypeDescription
successbooleanWhether the variable was deleted

On this page