Integrate Railway into workflows to list projects, manage services and environments, monitor deployments, trigger and roll back service deployments, and manage environment variables.
List Railway projects visible to the provided token
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
workspaceId | string | No | Workspace ID to list projects from |
first | number | No | Maximum number of projects to return |
after | string | No | Cursor for pagination |
| Parameter | Type | Description |
|---|
projects | array | Railway projects |
pageInfo | object | Pagination information |
count | number | Number of projects returned |
Get a Railway project with its services and environments
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
| Parameter | Type | Description |
|---|
project | object | Project with services and environments |
Create a Railway project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
name | string | Yes | Project name |
description | string | No | Project description |
workspaceId | string | No | Workspace ID to create the project in |
isPublic | boolean | No | Whether the project should be publicly visible |
defaultEnvironmentName | string | No | Name for the default environment |
prDeploys | boolean | No | Whether to enable pull request deploys |
| Parameter | Type | Description |
|---|
project | object | Created project |
Update a Railway project name or description
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
name | string | No | Updated project name |
description | string | No | Updated project description |
isPublic | boolean | No | Whether the project should be publicly visible |
prDeploys | boolean | No | Whether to enable pull request deploy environments |
| Parameter | Type | Description |
|---|
project | object | Updated project |
Delete a Railway project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
| Parameter | Type | Description |
|---|
success | boolean | Whether the project was deleted |
Transfer a Railway project to another workspace
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
workspaceId | string | Yes | Destination workspace ID |
| Parameter | Type | Description |
|---|
success | boolean | Whether the project was transferred |
List members for a Railway project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
| Parameter | Type | Description |
|---|
members | array | Project members |
count | number | Number of members returned |
Create a Railway project environment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
name | string | Yes | Environment name |
sourceEnvironmentId | string | No | Environment ID to clone from |
ephemeral | boolean | No | Whether the environment is ephemeral |
skipInitialDeploys | boolean | No | Whether to skip initial deploys for the environment |
stageInitialChanges | boolean | No | Whether to stage initial changes instead of applying them immediately |
| Parameter | Type | Description |
|---|
environment | object | Created environment |
Delete a Railway project environment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
environmentId | string | Yes | Railway environment ID |
| Parameter | Type | Description |
|---|
success | boolean | Whether the environment was deleted |
Create a Railway service from a GitHub repo or Docker image
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
name | string | Yes | Service name |
repo | string | No | GitHub repository in owner/name format to deploy from |
image | string | No | Docker image to deploy, for example redis:7-alpine |
branch | string | No | Git branch to deploy when using a repository source |
| Parameter | Type | Description |
|---|
service | object | Created service |
Delete a Railway service and all of its deployments
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
serviceId | string | Yes | Railway service ID |
| Parameter | Type | Description |
|---|
success | boolean | Whether the service was deleted |
List deployments for a Railway service in an environment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
serviceId | string | Yes | Railway service ID |
environmentId | string | Yes | Railway environment ID |
first | number | No | Maximum number of deployments to return |
after | string | No | Cursor for pagination |
| Parameter | Type | Description |
|---|
deployments | array | Service deployments |
count | number | Number of deployments returned |
pageInfo | object | Pagination information |
Get details for a single Railway deployment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
deploymentId | string | Yes | Railway deployment ID |
| Parameter | Type | Description |
|---|
deployment | object | Deployment details |
Trigger a deployment for a Railway service in an environment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
serviceId | string | Yes | Railway service ID |
environmentId | string | Yes | Railway environment ID |
commitSha | string | No | Specific Git commit SHA to deploy |
| Parameter | Type | Description |
|---|
deploymentId | string | Created deployment ID |
Restart a running Railway deployment without rebuilding
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
deploymentId | string | Yes | Railway deployment ID |
| Parameter | Type | Description |
|---|
success | boolean | Whether the deployment was restarted |
Roll a Railway service back to a previous deployment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
deploymentId | string | Yes | Railway deployment ID to roll back to (must have canRollback) |
| Parameter | Type | Description |
|---|
success | boolean | Whether the rollback was triggered |
Retrieve runtime logs for a Railway deployment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
deploymentId | string | Yes | Railway deployment ID |
limit | number | No | Maximum number of log lines to return |
| Parameter | Type | Description |
|---|
logs | array | Deployment log entries |
count | number | Number of log entries returned |
List Railway environment variables for a service or shared environment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
environmentId | string | Yes | Railway environment ID |
serviceId | string | No | Railway service ID. Omit for shared environment variables. |
| Parameter | Type | Description |
|---|
variables | object | Variable names and values |
count | number | Number of variables returned |
Create or update a Railway environment variable
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
environmentId | string | Yes | Railway environment ID |
serviceId | string | No | Railway service ID. Omit to create or update a shared variable. |
name | string | Yes | Variable name |
value | string | Yes | Variable value |
skipDeploys | boolean | No | Whether to skip automatic redeploys after changing the variable |
| Parameter | Type | Description |
|---|
success | boolean | Whether the variable was created or updated |
Delete a Railway environment variable
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Railway API token |
tokenType | string | No | Railway token type. Use "account" for account, workspace, or OAuth tokens, or "project" for project tokens. |
projectId | string | Yes | Railway project ID |
environmentId | string | Yes | Railway environment ID |
name | string | Yes | Variable name to delete |
serviceId | string | No | Railway service ID. Omit to delete a shared variable. |
| Parameter | Type | Description |
|---|
success | boolean | Whether the variable was deleted |
- Category:
tools
- Type:
railway