Railway

Manage Railway projects, services, deployments, and variables

Nutzungsanweisungen

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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`workspaceId`	string	Nein	Workspace ID to list projects from
`first`	number	Nein	Maximum number of projects to return
`after`	string	Nein	Cursor for pagination

Ausgabe

Parameter	Typ	Beschreibung
`projects`	array	Railway projects
↳ `id`	string	Project ID
↳ `name`	string	Project name
↳ `description`	string	Project description
↳ `createdAt`	string	Project creation timestamp
↳ `updatedAt`	string	Project update timestamp
`pageInfo`	object	Pagination information
↳ `hasNextPage`	boolean	Whether more projects are available
↳ `endCursor`	string	Cursor for the next page
`count`	number	Number of projects returned

`railway_get_project`

Get a Railway project with its services and environments

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID

Ausgabe

Parameter	Typ	Beschreibung
`project`	object	Project with services and environments
↳ `id`	string	Project ID
↳ `name`	string	Project name
↳ `description`	string	Project description
↳ `createdAt`	string	Project creation timestamp
↳ `updatedAt`	string	Project update timestamp
↳ `services`	array	Project services
↳ `id`	string	Service ID
↳ `name`	string	Service name
↳ `icon`	string	Service icon
↳ `environments`	array	Project environments
↳ `id`	string	Environment ID
↳ `name`	string	Environment name

`railway_create_project`

Create a Railway project

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`name`	string	Ja	Project name
`description`	string	Nein	Project description
`workspaceId`	string	Nein	Workspace ID to create the project in
`isPublic`	boolean	Nein	Whether the project should be publicly visible
`defaultEnvironmentName`	string	Nein	Name for the default environment
`prDeploys`	boolean	Nein	Whether to enable pull request deploys

Ausgabe

Parameter	Typ	Beschreibung
`project`	object	Created project
↳ `id`	string	Project ID
↳ `name`	string	Project name

`railway_update_project`

Update a Railway project name or description

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID
`name`	string	Nein	Updated project name
`description`	string	Nein	Updated project description
`isPublic`	boolean	Nein	Whether the project should be publicly visible
`prDeploys`	boolean	Nein	Whether to enable pull request deploy environments

Ausgabe

Parameter	Typ	Beschreibung
`project`	object	Updated project
↳ `id`	string	Project ID
↳ `name`	string	Project name
↳ `description`	string	Project description

`railway_delete_project`

Delete a Railway project

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the project was deleted

`railway_transfer_project`

Transfer a Railway project to another workspace

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID
`workspaceId`	string	Ja	Destination workspace ID

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the project was transferred

`railway_list_project_members`

List members for a Railway project

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID

Ausgabe

Parameter	Typ	Beschreibung
`members`	array	Project members
↳ `id`	string	Member user ID
↳ `role`	string	Project role
↳ `name`	string	Member name
↳ `email`	string	Member email
↳ `avatar`	string	Member avatar URL
`count`	number	Number of members returned

`railway_create_environment`

Create a Railway project environment

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID
`name`	string	Ja	Environment name
`sourceEnvironmentId`	string	Nein	Environment ID to clone from
`ephemeral`	boolean	Nein	Whether the environment is ephemeral
`skipInitialDeploys`	boolean	Nein	Whether to skip initial deploys for the environment
`stageInitialChanges`	boolean	Nein	Whether to stage initial changes instead of applying them immediately

Ausgabe

Parameter	Typ	Beschreibung
`environment`	object	Created environment
↳ `id`	string	Environment ID
↳ `name`	string	Environment name

`railway_delete_environment`

Delete a Railway project environment

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`environmentId`	string	Ja	Railway environment ID

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the environment was deleted

`railway_create_service`

Create a Railway service from a GitHub repo or Docker image

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID
`name`	string	Ja	Service name
`repo`	string	Nein	GitHub repository in owner/name format to deploy from
`image`	string	Nein	Docker image to deploy, for example redis:7-alpine
`branch`	string	Nein	Git branch to deploy when using a repository source

Ausgabe

Parameter	Typ	Beschreibung
`service`	object	Created service
↳ `id`	string	Service ID
↳ `name`	string	Service name

`railway_delete_service`

Delete a Railway service and all of its deployments

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`serviceId`	string	Ja	Railway service ID

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the service was deleted

`railway_list_deployments`

List deployments for a Railway service in an environment

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID
`serviceId`	string	Ja	Railway service ID
`environmentId`	string	Ja	Railway environment ID
`first`	number	Nein	Maximum number of deployments to return
`after`	string	Nein	Cursor for pagination

Ausgabe

Parameter	Typ	Beschreibung
`deployments`	array	Service deployments
↳ `id`	string	Deployment ID
↳ `status`	string	Deployment status
↳ `createdAt`	string	Deployment creation timestamp
↳ `url`	string	Deployment URL
↳ `staticUrl`	string	Static deployment URL
↳ `canRollback`	boolean	Whether this deployment can be rolled back to
↳ `canRedeploy`	boolean	Whether this deployment can be redeployed
`count`	number	Number of deployments returned
`pageInfo`	object	Pagination information
↳ `hasNextPage`	boolean	Whether more deployments are available
↳ `endCursor`	string	Cursor for the next page

`railway_get_deployment`

Get details for a single Railway deployment

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`deploymentId`	string	Ja	Railway deployment ID

Ausgabe

Parameter	Typ	Beschreibung
`deployment`	object	Deployment details
↳ `id`	string	Deployment ID
↳ `status`	string	Deployment status
↳ `createdAt`	string	Deployment creation timestamp
↳ `url`	string	Deployment URL
↳ `staticUrl`	string	Static deployment URL
↳ `canRollback`	boolean	Whether the deployment can be rolled back to
↳ `canRedeploy`	boolean	Whether the deployment can be redeployed

`railway_deploy_service`

Trigger a deployment for a Railway service in an environment

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`serviceId`	string	Ja	Railway service ID
`environmentId`	string	Ja	Railway environment ID
`commitSha`	string	Nein	Specific Git commit SHA to deploy

Ausgabe

Parameter	Typ	Beschreibung
`deploymentId`	string	Created deployment ID

`railway_restart_deployment`

Restart a running Railway deployment without rebuilding

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`deploymentId`	string	Ja	Railway deployment ID

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the deployment was restarted

`railway_rollback_deployment`

Roll a Railway service back to a previous deployment

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`deploymentId`	string	Ja	Railway deployment ID to roll back to (must have canRollback)

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the rollback was triggered

`railway_get_deployment_logs`

Retrieve runtime logs for a Railway deployment

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`deploymentId`	string	Ja	Railway deployment ID
`limit`	number	Nein	Maximum number of log lines to return

Ausgabe

Parameter	Typ	Beschreibung
`logs`	array	Deployment log entries
↳ `timestamp`	string	Log timestamp
↳ `message`	string	Log message
↳ `severity`	string	Log severity
`count`	number	Number of log entries returned

`railway_list_variables`

List Railway environment variables for a service or shared environment

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID
`environmentId`	string	Ja	Railway environment ID
`serviceId`	string	Nein	Railway service ID. Omit for shared environment variables.

Ausgabe

Parameter	Typ	Beschreibung
`variables`	object	Variable names and values
`count`	number	Number of variables returned

`railway_upsert_variable`

Create or update a Railway environment variable

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID
`environmentId`	string	Ja	Railway environment ID
`serviceId`	string	Nein	Railway service ID. Omit to create or update a shared variable.
`name`	string	Ja	Variable name
`value`	string	Ja	Variable value
`skipDeploys`	boolean	Nein	Whether to skip automatic redeploys after changing the variable

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the variable was created or updated

`railway_delete_variable`

Delete a Railway environment variable

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Railway API token
`tokenType`	string	Nein	Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens.
`projectId`	string	Ja	Railway project ID
`environmentId`	string	Ja	Railway environment ID
`name`	string	Ja	Variable name to delete
`serviceId`	string	Nein	Railway service ID. Omit to delete a shared variable.

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the variable was deleted