Mandala
Tools

Railway

Manage Railway projects, services, deployments, and variables

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.

Tools

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
pageInfoobjectPagination information
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

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

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

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
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

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

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
countnumberNumber of deployments returned
pageInfoobjectPagination information

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

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
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

Notes

  • Category: tools
  • Type: railway
Railway