API Cookbook
This cookbook provides quick copy-paste examples for common API operations. For detailed explanations, see the linked guides.
Quick setup
GraphQL Endpoint:
Authentication:
Test your connection:
Projects
See Manage Projects for more details.
List all projects
Get project with services
Required
Variables
Create a project
Required
Variables
Services
See Manage Services for more details.
Create service from GitHub
Required
Variables
Create service from Docker image
Required
Variables
Update service settings
Required
Variables
Deployments
See Manage Deployments for more details.
List recent deployments
Required
Variables
Get deployment logs
Required
Variables
Deploy
Required
Variables
Rollback
Required
Variables
Variables
See Manage Variables for more details.
Get variables
Required
Variables
Set variables
Required
Variables
Environments
List environments
Required
Variables
Create environment
Required
Variables
Domains
Add Railway domain
Required
Variables
Add custom domain
Required
Variables
Volumes
Create volume
Required
Variables
Create backup
Required
Variables
TCP proxies
List TCP proxies
Required
Variables
Workspaces
Get workspace
Required
Variables
Useful queries
Get project token info
Use with a project token:
List available regions
Tips
Finding IDs
Press Cmd/Ctrl + K in the Railway dashboard and search for "Copy Project ID", "Copy Service ID", or "Copy Environment ID".
Using the network tab
Do the action in the Railway dashboard and inspect the network tab to see the exact GraphQL queries used.
GraphiQL playground
Test queries interactively at railway.com/graphiql.