Sunbelt Computer Software

PL/B Language Development and Support

Railway | Sim Docs

Railway

Use Railway to list projects, inspect their services and environments, monitor deployments, deploy a service, or roll back a deployment. Read or update service and shared environment variables through Railway's public GraphQL API.

Use project, service, and environment IDs from lookup actions in later release steps. Confirm the target environment before changing variables or starting a deployment.

Use the block

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

Actions

Railway List Projects

List Railway projects visible to the provided token

Inputs and outputs

Input

Output

Parameter	Type	Description
`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

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`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

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`project`	object	Created project
↳ `id`	string	Project ID
↳ `name`	string	Project name

Railway Update Project

Update a Railway project name or description

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`project`	object	Updated project
↳ `id`	string	Project ID
↳ `name`	string	Project name
↳ `description`	string	Project description

Railway Delete Project

Delete a Railway project

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`success`	boolean	Whether the project was deleted

Railway Transfer Project

Transfer a Railway project to another workspace

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`success`	boolean	Whether the project was transferred

Railway List Project Members

List members for a Railway project

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`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

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`environment`	object	Created environment
↳ `id`	string	Environment ID
↳ `name`	string	Environment name

Railway Delete Environment

Delete a Railway project environment

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`success`	boolean	Whether the environment was deleted

Railway Create Service

Create a Railway service from a GitHub repo or Docker image

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`service`	object	Created service
↳ `id`	string	Service ID
↳ `name`	string	Service name

Railway Delete Service

Delete a Railway service and all of its deployments

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`success`	boolean	Whether the service was deleted

Railway List Deployments

List deployments for a Railway service in an environment

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`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

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`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

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`deploymentId`	string	Created deployment ID

Railway Restart Deployment

Restart a running Railway deployment without rebuilding

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`success`	boolean	Whether the deployment was restarted

Railway Rollback Deployment

Roll a Railway service back to a previous deployment

Inputs and outputs

Input

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)

Output

Parameter	Type	Description
`success`	boolean	Whether the rollback was triggered

Railway Get Deployment Logs

Retrieve runtime logs for a Railway deployment

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`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

Inputs and outputs

Input

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.

Output

Parameter	Type	Description
`variables`	object	Variable names and values
`count`	number	Number of variables returned

Railway Upsert Variable

Create or update a Railway environment variable

Inputs and outputs

Input

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

Output

Parameter	Type	Description
`success`	boolean	Whether the variable was created or updated

Railway Delete Variable

Delete a Railway environment variable

Inputs and outputs

Input

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.

Output