AptlyStar

Railway

Manage Railway projects, services, deployments, and variables

Instructions d'utilisation

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

Outils

railway_list_projects

List Railway projects visible to the provided token

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
workspaceIdstringNonWorkspace ID to list projects from
firstnumberNonMaximum number of projects to return
afterstringNonCursor for pagination

Sortie

ParamètreTypeDescription
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

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID

Sortie

ParamètreTypeDescription
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

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
namestringOuiProject name
descriptionstringNonProject description
workspaceIdstringNonWorkspace ID to create the project in
isPublicbooleanNonWhether the project should be publicly visible
defaultEnvironmentNamestringNonName for the default environment
prDeploysbooleanNonWhether to enable pull request deploys

Sortie

ParamètreTypeDescription
projectobjectCreated project
↳ idstringProject ID
↳ namestringProject name

railway_update_project

Update a Railway project name or description

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID
namestringNonUpdated project name
descriptionstringNonUpdated project description
isPublicbooleanNonWhether the project should be publicly visible
prDeploysbooleanNonWhether to enable pull request deploy environments

Sortie

ParamètreTypeDescription
projectobjectUpdated project
↳ idstringProject ID
↳ namestringProject name
↳ descriptionstringProject description

railway_delete_project

Delete a Railway project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID

Sortie

ParamètreTypeDescription
successbooleanWhether the project was deleted

railway_transfer_project

Transfer a Railway project to another workspace

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID
workspaceIdstringOuiDestination workspace ID

Sortie

ParamètreTypeDescription
successbooleanWhether the project was transferred

railway_list_project_members

List members for a Railway project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID

Sortie

ParamètreTypeDescription
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

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID
namestringOuiEnvironment name
sourceEnvironmentIdstringNonEnvironment ID to clone from
ephemeralbooleanNonWhether the environment is ephemeral
skipInitialDeploysbooleanNonWhether to skip initial deploys for the environment
stageInitialChangesbooleanNonWhether to stage initial changes instead of applying them immediately

Sortie

ParamètreTypeDescription
environmentobjectCreated environment
↳ idstringEnvironment ID
↳ namestringEnvironment name

railway_delete_environment

Delete a Railway project environment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
environmentIdstringOuiRailway environment ID

Sortie

ParamètreTypeDescription
successbooleanWhether the environment was deleted

railway_create_service

Create a Railway service from a GitHub repo or Docker image

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID
namestringOuiService name
repostringNonGitHub repository in owner/name format to deploy from
imagestringNonDocker image to deploy, for example redis:7-alpine
branchstringNonGit branch to deploy when using a repository source

Sortie

ParamètreTypeDescription
serviceobjectCreated service
↳ idstringService ID
↳ namestringService name

railway_delete_service

Delete a Railway service and all of its deployments

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
serviceIdstringOuiRailway service ID

Sortie

ParamètreTypeDescription
successbooleanWhether the service was deleted

railway_list_deployments

List deployments for a Railway service in an environment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID
serviceIdstringOuiRailway service ID
environmentIdstringOuiRailway environment ID
firstnumberNonMaximum number of deployments to return
afterstringNonCursor for pagination

Sortie

ParamètreTypeDescription
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

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringOuiRailway deployment ID

Sortie

ParamètreTypeDescription
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

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
serviceIdstringOuiRailway service ID
environmentIdstringOuiRailway environment ID
commitShastringNonSpecific Git commit SHA to deploy

Sortie

ParamètreTypeDescription
deploymentIdstringCreated deployment ID

railway_restart_deployment

Restart a running Railway deployment without rebuilding

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringOuiRailway deployment ID

Sortie

ParamètreTypeDescription
successbooleanWhether the deployment was restarted

railway_rollback_deployment

Roll a Railway service back to a previous deployment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringOuiRailway deployment ID to roll back to (must have canRollback)

Sortie

ParamètreTypeDescription
successbooleanWhether the rollback was triggered

railway_get_deployment_logs

Retrieve runtime logs for a Railway deployment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringOuiRailway deployment ID
limitnumberNonMaximum number of log lines to return

Sortie

ParamètreTypeDescription
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

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID
environmentIdstringOuiRailway environment ID
serviceIdstringNonRailway service ID. Omit for shared environment variables.

Sortie

ParamètreTypeDescription
variablesobjectVariable names and values
countnumberNumber of variables returned

railway_upsert_variable

Create or update a Railway environment variable

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID
environmentIdstringOuiRailway environment ID
serviceIdstringNonRailway service ID. Omit to create or update a shared variable.
namestringOuiVariable name
valuestringOuiVariable value
skipDeploysbooleanNonWhether to skip automatic redeploys after changing the variable

Sortie

ParamètreTypeDescription
successbooleanWhether the variable was created or updated

railway_delete_variable

Delete a Railway environment variable

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiRailway API token
tokenTypestringNonRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringOuiRailway project ID
environmentIdstringOuiRailway environment ID
namestringOuiVariable name to delete
serviceIdstringNonRailway service ID. Omit to delete a shared variable.

Sortie

ParamètreTypeDescription
successbooleanWhether the variable was deleted

On this page