AptlyStar

Railway

Manage Railway projects, services, deployments, and variables

Instrucciones de uso

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

Herramientas

railway_list_projects

List Railway projects visible to the provided token

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway 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

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
namestringSíProject 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

Salida

ParámetroTipoDescripción
projectobjectCreated project
↳ idstringProject ID
↳ namestringProject name

railway_update_project

Update a Railway project name or description

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID
namestringNoUpdated project name
descriptionstringNoUpdated project description
isPublicbooleanNoWhether the project should be publicly visible
prDeploysbooleanNoWhether to enable pull request deploy environments

Salida

ParámetroTipoDescripción
projectobjectUpdated project
↳ idstringProject ID
↳ namestringProject name
↳ descriptionstringProject description

railway_delete_project

Delete a Railway project

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID

Salida

ParámetroTipoDescripción
successbooleanWhether the project was deleted

railway_transfer_project

Transfer a Railway project to another workspace

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID
workspaceIdstringSíDestination workspace ID

Salida

ParámetroTipoDescripción
successbooleanWhether the project was transferred

railway_list_project_members

List members for a Railway project

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID
namestringSíEnvironment 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

Salida

ParámetroTipoDescripción
environmentobjectCreated environment
↳ idstringEnvironment ID
↳ namestringEnvironment name

railway_delete_environment

Delete a Railway project environment

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
environmentIdstringSíRailway environment ID

Salida

ParámetroTipoDescripción
successbooleanWhether the environment was deleted

railway_create_service

Create a Railway service from a GitHub repo or Docker image

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID
namestringSíService 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

Salida

ParámetroTipoDescripción
serviceobjectCreated service
↳ idstringService ID
↳ namestringService name

railway_delete_service

Delete a Railway service and all of its deployments

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
serviceIdstringSíRailway service ID

Salida

ParámetroTipoDescripción
successbooleanWhether the service was deleted

railway_list_deployments

List deployments for a Railway service in an environment

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID
serviceIdstringSíRailway service ID
environmentIdstringSíRailway environment ID
firstnumberNoMaximum number of deployments to return
afterstringNoCursor for pagination

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringSíRailway deployment ID

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
serviceIdstringSíRailway service ID
environmentIdstringSíRailway environment ID
commitShastringNoSpecific Git commit SHA to deploy

Salida

ParámetroTipoDescripción
deploymentIdstringCreated deployment ID

railway_restart_deployment

Restart a running Railway deployment without rebuilding

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringSíRailway deployment ID

Salida

ParámetroTipoDescripción
successbooleanWhether the deployment was restarted

railway_rollback_deployment

Roll a Railway service back to a previous deployment

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringSíRailway deployment ID to roll back to (must have canRollback)

Salida

ParámetroTipoDescripción
successbooleanWhether the rollback was triggered

railway_get_deployment_logs

Retrieve runtime logs for a Railway deployment

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringSíRailway deployment ID
limitnumberNoMaximum number of log lines to return

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID
environmentIdstringSíRailway environment ID
serviceIdstringNoRailway service ID. Omit for shared environment variables.

Salida

ParámetroTipoDescripción
variablesobjectVariable names and values
countnumberNumber of variables returned

railway_upsert_variable

Create or update a Railway environment variable

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID
environmentIdstringSíRailway environment ID
serviceIdstringNoRailway service ID. Omit to create or update a shared variable.
namestringSíVariable name
valuestringSíVariable value
skipDeploysbooleanNoWhether to skip automatic redeploys after changing the variable

Salida

ParámetroTipoDescripción
successbooleanWhether the variable was created or updated

railway_delete_variable

Delete a Railway environment variable

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíRailway API token
tokenTypestringNoRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringSíRailway project ID
environmentIdstringSíRailway environment ID
namestringSíVariable name to delete
serviceIdstringNoRailway service ID. Omit to delete a shared variable.

Salida

ParámetroTipoDescripción
successbooleanWhether the variable was deleted

On this page