Skip to main content
Railway logo

Overview

Add Railway to any ModuleX agent or workflow. Manage Railway projects, services, environments, deployments, and environment variables against Railway’s public GraphQL API (backboard.railway.com/graphql/v2).
Categories: Developer Tools & Infrastructure · Cloud · Ci Cd · Auth: API Token · Actions: 20

Authentication

API Token Authentication

Authenticate using your Railway API token
1

Step 1

Sign in at https://railway.com and open your account settings
2

Step 2

Go to the ‘Tokens’ section under Account Settings
3

Step 3

Create a new token (account, workspace, or project scope)
4

Step 4

Paste the token below

Required Credentials

Available Actions

Parameters

string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
string
Workspace ID to list projects from
integer
Maximum number of projects to return
string
Cursor for pagination

Response

Parameters

string
required
Railway project ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)

Response

Parameters

string
required
Project name
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
string
Project description
string
Workspace ID to create the project in
boolean
Whether the project should be publicly visible
string
Name for the default environment
boolean
Whether to enable pull request deploys

Response

Parameters

string
required
Railway project ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
string
Updated project name
string
Updated project description
boolean
Whether the project should be publicly visible
boolean
Whether to enable pull request deploy environments

Response

Parameters

string
required
Railway project ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)

Response

Parameters

string
required
Railway project ID
string
required
Destination workspace ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)

Response

Parameters

string
required
Railway project ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)

Response

Parameters

string
required
Railway project ID
string
required
Environment name
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
string
Environment ID to clone from
boolean
Whether the environment is ephemeral
boolean
Whether to skip initial deploys for the environment
boolean
Whether to stage initial changes instead of applying them immediately

Response

Parameters

string
required
Railway environment ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)

Response

Parameters

string
required
Railway project ID
string
required
Service name
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
string
GitHub repository in owner/name format to deploy from
string
Docker image to deploy, for example redis:7-alpine
string
Git branch to deploy when using a repository source

Response

Parameters

string
required
Railway service ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)

Response

Parameters

string
required
Railway project ID
string
required
Railway service ID
string
required
Railway environment ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
integer
Maximum number of deployments to return
string
Cursor for pagination

Response

Parameters

string
required
Railway deployment ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)

Response

Parameters

string
required
Railway service ID
string
required
Railway environment ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
string
Specific Git commit SHA to deploy

Response

Parameters

string
required
Railway deployment ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)

Response

Parameters

string
required
Railway deployment ID to roll back to (must have canRollback)
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)

Response

Parameters

string
required
Railway deployment ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
integer
Maximum number of log lines to return

Response

Parameters

string
required
Railway project ID
string
required
Railway environment ID
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
string
Railway service ID. Omit for shared environment variables.

Response

Parameters

string
required
Railway project ID
string
required
Railway environment ID
string
required
Variable name
string
required
Variable value
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
string
Railway service ID. Omit to create or update a shared variable.
boolean
Whether to skip automatic redeploys after changing the variable

Response

Parameters

string
required
Railway project ID
string
required
Railway environment ID
string
required
Variable name to delete
string
Railway token type. Use “account” for account, workspace, or OAuth tokens, or “project” for project tokens. (Default: account)
string
Railway service ID. Omit to delete a shared variable.

Response

Limits & Quotas

  • Transport: every action is a single POST to the GraphQL endpoint https://backboard.railway.com/graphql/v2.
  • Rate limits: Railway applies request-rate and complexity limits to the public API; see the official API docs for current values.
  • Error model: the GraphQL endpoint answers HTTP 200 even for logical errors, returning them in a top-level errors array. These, along with non-2xx responses and timeouts, are caught and returned as success=False + error rather than raising. Plan for retries on the agent side based on the error string.

Daytona

Netlify

Algolia