AptlyStar

Railway

Manage Railway projects, services, deployments, and variables

使用方法

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

ツール

railway_list_projects

List Railway projects visible to the provided token

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
workspaceIdstringいいえWorkspace ID to list projects from
firstnumberいいえMaximum number of projects to return
afterstringいいえCursor for pagination

出力

パラメータ型説明
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

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID

出力

パラメータ型説明
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

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
namestringはいProject name
descriptionstringいいえProject description
workspaceIdstringいいえWorkspace ID to create the project in
isPublicbooleanいいえWhether the project should be publicly visible
defaultEnvironmentNamestringいいえName for the default environment
prDeploysbooleanいいえWhether to enable pull request deploys

出力

パラメータ型説明
projectobjectCreated project
↳ idstringProject ID
↳ namestringProject name

railway_update_project

Update a Railway project name or description

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID
namestringいいえUpdated project name
descriptionstringいいえUpdated project description
isPublicbooleanいいえWhether the project should be publicly visible
prDeploysbooleanいいえWhether to enable pull request deploy environments

出力

パラメータ型説明
projectobjectUpdated project
↳ idstringProject ID
↳ namestringProject name
↳ descriptionstringProject description

railway_delete_project

Delete a Railway project

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID

出力

パラメータ型説明
successbooleanWhether the project was deleted

railway_transfer_project

Transfer a Railway project to another workspace

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID
workspaceIdstringはいDestination workspace ID

出力

パラメータ型説明
successbooleanWhether the project was transferred

railway_list_project_members

List members for a Railway project

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID

出力

パラメータ型説明
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

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID
namestringはいEnvironment name
sourceEnvironmentIdstringいいえEnvironment ID to clone from
ephemeralbooleanいいえWhether the environment is ephemeral
skipInitialDeploysbooleanいいえWhether to skip initial deploys for the environment
stageInitialChangesbooleanいいえWhether to stage initial changes instead of applying them immediately

出力

パラメータ型説明
environmentobjectCreated environment
↳ idstringEnvironment ID
↳ namestringEnvironment name

railway_delete_environment

Delete a Railway project environment

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
environmentIdstringはいRailway environment ID

出力

パラメータ型説明
successbooleanWhether the environment was deleted

railway_create_service

Create a Railway service from a GitHub repo or Docker image

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID
namestringはいService name
repostringいいえGitHub repository in owner/name format to deploy from
imagestringいいえDocker image to deploy, for example redis:7-alpine
branchstringいいえGit branch to deploy when using a repository source

出力

パラメータ型説明
serviceobjectCreated service
↳ idstringService ID
↳ namestringService name

railway_delete_service

Delete a Railway service and all of its deployments

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
serviceIdstringはいRailway service ID

出力

パラメータ型説明
successbooleanWhether the service was deleted

railway_list_deployments

List deployments for a Railway service in an environment

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID
serviceIdstringはいRailway service ID
environmentIdstringはいRailway environment ID
firstnumberいいえMaximum number of deployments to return
afterstringいいえCursor for pagination

出力

パラメータ型説明
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

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringはいRailway deployment ID

出力

パラメータ型説明
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

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
serviceIdstringはいRailway service ID
environmentIdstringはいRailway environment ID
commitShastringいいえSpecific Git commit SHA to deploy

出力

パラメータ型説明
deploymentIdstringCreated deployment ID

railway_restart_deployment

Restart a running Railway deployment without rebuilding

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringはいRailway deployment ID

出力

パラメータ型説明
successbooleanWhether the deployment was restarted

railway_rollback_deployment

Roll a Railway service back to a previous deployment

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringはいRailway deployment ID to roll back to (must have canRollback)

出力

パラメータ型説明
successbooleanWhether the rollback was triggered

railway_get_deployment_logs

Retrieve runtime logs for a Railway deployment

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
deploymentIdstringはいRailway deployment ID
limitnumberいいえMaximum number of log lines to return

出力

パラメータ型説明
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

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID
environmentIdstringはいRailway environment ID
serviceIdstringいいえRailway service ID. Omit for shared environment variables.

出力

パラメータ型説明
variablesobjectVariable names and values
countnumberNumber of variables returned

railway_upsert_variable

Create or update a Railway environment variable

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID
environmentIdstringはいRailway environment ID
serviceIdstringいいえRailway service ID. Omit to create or update a shared variable.
namestringはいVariable name
valuestringはいVariable value
skipDeploysbooleanいいえWhether to skip automatic redeploys after changing the variable

出力

パラメータ型説明
successbooleanWhether the variable was created or updated

railway_delete_variable

Delete a Railway environment variable

入力

パラメータ型必須説明
apiKeystringはいRailway API token
tokenTypestringいいえRailway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
projectIdstringはいRailway project ID
environmentIdstringはいRailway environment ID
namestringはいVariable name to delete
serviceIdstringいいえRailway service ID. Omit to delete a shared variable.

出力

パラメータ型説明
successbooleanWhether the variable was deleted

On this page