Skip to main content
Railway logo
  • Category: developer tools
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 59
  • Triggers: 0
  • Slug: RAILWAY
  • Version: 20261101_00

Tools

Slug: RAILWAY_ADD_ACCESS_GROUP_MEMBERAdd a workspace member to an access group.

Input Parameters

object
required
Structured parameters for access group member add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ADD_FEATURE_FLAGAdd a feature flag for a user

Input Parameters

object
required
Structured parameters for feature flag add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ADD_PROJECT_FEATURE_FLAGAdd a feature flag for a project

Input Parameters

object
required
Structured parameters for project feature flag add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ADD_PROJECT_MEMBERAdd a workspace member to a project with a specific role. The user must already be a member of the project’s workspace.

Input Parameters

object
required
Structured parameters for project member add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ADD_SERVICE_FEATURE_FLAGAdd a feature flag for a service

Input Parameters

object
required
Structured parameters for service feature flag add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ADD_WORKSPACE_POLICY_DEPLOY_SOURCE_ALLOWLISTAdd a deploy source to a workspace policy allowlist.

Input Parameters

string
required
Railway source ID required by workspace policy deploy source allowlist add.
string
required
Source type supplied to workspace policy deploy source allowlist add.
string
required
Railway workspace ID required by workspace policy deploy source allowlist add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_APPROVE_DEPLOYMENTApproves a deployment.

Input Parameters

string
required
Railway id ID required by deployment approve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ARCHIVE_CLOUD_AGENTArchive a cloud agent: hide it from lists that ask for unarchived agents. Its machine, sessions and history are untouched. Owner only.

Input Parameters

string
required
Railway id ID required by cloud agent archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ATTACH_ACCESS_GROUP_PROJECTAttach a project to an access group.

Input Parameters

object
required
Structured parameters for access group project attach.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_BUILD_SANDBOX_TEMPLATEBuild a sandbox template into a bootable checkpoint.

Input Parameters

object
required
Structured parameters for sandbox template build.
string
required
Railway environment ID required by sandbox template build.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CANCEL_CLOUD_AGENT_TASKStop a task. Before its prompt is sent it never starts; after, only its own run is aborted. The task ends failed with “The task was cancelled”. A finished task is left as is.

Input Parameters

string
required
Railway task ID required by cloud agent task cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CANCEL_DEPLOYMENTCancel a Railway deployment that is queued or building, preventing that in-progress deployment from completing. This does not stop a running deployment and requires confirm=true.

Input Parameters

boolean
required
Must be true to confirm cancelling the deployment.
string
required
Deployment ID to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CANCEL_PITR_HA_WORKFLOWCancels an in-progress PITR enable/disable rollout on an HA database cluster and resets its progress so the UI re-reads from the live cluster. No-ops when nothing is running.

Input Parameters

string
required
Railway environment ID required by cancel pitr ha workflow.
string
required
Railway root service ID required by cancel pitr ha workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CANCEL_PROJECT_SCHEDULE_DELETECancel scheduled deletion of a project

Input Parameters

string
required
Railway id ID required by project schedule delete cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CHECK_ENVIRONMENT_LEGACY_STATIC_EGRESSCheck whether any Railway service in an environment uses legacy static egress rather than high-availability static egress. Returns a Boolean suitable for identifying environments needing HA migration. Read-only: does not enable, disable or migrate egress.

Input Parameters

string
required
ID of the environment to check for legacy static egress.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CHECK_PRIVATE_NETWORK_ENDPOINT_NAMECheck whether a proposed private-network endpoint name prefix is available in a Railway environment and private network. Returns an availability boolean; false means unavailable, not an execution error. Does not reserve the name, create an endpoint or change DNS.

Input Parameters

string
required
Proposed private-network endpoint name prefix, not a full URL.
string
required
Environment ID in which to check the endpoint name.
string
required
Private network identifier; use publicId returned by privateNetworks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CHECK_SERVICE_DOMAIN_AVAILABILITYCheck whether a Railway service domain is available. Returns an availability Boolean and Railway’s explanatory message. A false result is a normal lookup result, not a transport error. This read-only check does not reserve, create or change a domain and does not guarantee future availability.

Input Parameters

string
required
Service domain to check with Railway. Passed unchanged; Railway validates its format and availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CHECK_SERVICE_INSTANCE_UPDATABLECheck whether the upstream repository for a Railway service instance has an update available. Returns Railway’s Boolean availability result; false is a valid result. This is an upstream repository update check, not an authorization or configuration-editability check. Does not pull changes, redeploy or modify the service.

Input Parameters

string
required
Service ID whose upstream repository update availability to check.
string
required
Environment ID containing the service instance to check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CLAIM_PROJECTClaims a project.

Input Parameters

string
required
Railway id ID required by project claim.
string
required
Railway workspace ID required by project claim.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CLAIM_X_AGENT_PROJECTClaim a build requested from @RailwayAgent on X into workspaceId. The caller’s connected X account must be the one that requested it.

Input Parameters

string
required
Railway build ID required by x agent project claim.
string
required
Railway workspace ID required by x agent project claim.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CLEAR_DEV_NEW_LANDING_TARGETForget the box ssh dev.new lands you in; the next connection creates a new one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CLEAR_EGRESS_GATEWAY_ASSOCIATIONSClear all egress gateway associations for a service instance

Input Parameters

object
required
Structured parameters for egress gateway associations clear.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CLEAR_PITR_HA_WORKFLOW_PROGRESSClears the recorded progress of a finished PITR enable/disable rollout so the Backups page starts fresh. A rollout still in progress cannot be cleared.

Input Parameters

string
required
Railway environment ID required by clear pitr ha workflow progress.
string
required
Railway root service ID required by clear pitr ha workflow progress.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CLEAR_SERVICE_INSTANCE_AUTO_UPDATE_SNOOZEUndo an active auto-update skip for a service instance, applied immediately (no config staging, no redeploy). The recurring maintenance window and update policy are untouched — the next scheduled occurrence fires normally again.

Input Parameters

string
required
Railway service ID required by service instance auto update snooze clear.
string
required
Railway environment ID required by service instance auto update snooze clear.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CLONE_TEMPLATEDuplicates an existing template

Input Parameters

object
required
Structured parameters for template clone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_COLLECT_DEPLOYMENT_EVIDENCECollect a bounded, best-effort Railway deployment evidence bundle from live-validated deployment, snapshot, event, service-instance, log, and metric sources. Results may be partial and report completeness and errors for each source. This tool performs no AI reasoning or root-cause diagnosis and does not modify code or open pull requests.

Input Parameters

string
Inclusive ISO 8601 evidence-window end. Omit to use the current time, subject to the 24-hour evidence-window bound.
integer
Maximum entries returned by each build and HTTP log source (1-100).
string
Inclusive ISO 8601 evidence-window start. Omit to derive a bounded window from deployment creation.
integer
Maximum deployment events returned from the first Relay page (1-100).
string
required
Deployment ID to investigate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_COMMIT_ENVIRONMENT_CHANGESCommit existing staged changes for a Railway environment, completing a staged STAGE_TEMPLATE or create-environment workflow. This irreversible update can start deployments unless skip_deploys=true and requires confirm=true.

Input Parameters

boolean
required
Must be true to confirm committing the staged changes and potentially starting deployments.
boolean
Whether Railway should commit without starting deployments. Defaults to false, which allows the commit to trigger deployments.
string
Optional message describing the staged environment changes.
string
required
Environment ID whose staged changes should be committed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CONFIGURE_BUCKETS_AND_PRIVATE_NETWORKCommit an explicit Railway patch for bucket creation, updates, or deletion and the environment private-network enabled state. Existing staged changes are not committed or replaced, and this tool does not change services, variables, or volumes. Bucket deletion is irreversible and requires confirm_destructive=true.

Input Parameters

object
required
Bucket and private-network changes to commit as an explicit patch.
string
Optional message recorded for this committed patch.
string
required
Environment ID whose bucket or private-network changes should be applied.
boolean
Set true to confirm irreversible bucket deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CONFIRM_PROJECT_TRANSFERConfirm the transfer of project ownership

Input Parameters

object
required
Structured parameters for project transfer confirm.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CONNECT_SERVICEConnect a service to a source

Input Parameters

string
required
Railway id ID required by service connect.
object
required
Structured parameters for service connect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_COUNT_TEMPLATESCount all published Railway templates in the public catalog. Returns one total without listing templates. Accepts no filters, workspace/project IDs or pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_ACCESS_GROUPCreate an access group in a workspace.

Input Parameters

object
required
Structured parameters for access group create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_BUCKETCreate a project-level Railway object-storage bucket and return its identity, ownership, and timestamps. This single mutation does not apply an environment configuration patch or select a storage region; environment deployment may require separate configuration. Returns metadata only, without S3 credentials.

Input Parameters

string
Optional bucket name; omit to use Railway’s assigned name.
string
required
Project ID in which to create the bucket.
string
Environment ID hint. Railway currently marks this input unimplemented. The schema describes omission as deploying to all environments and explicit null as deploying to none; do not rely on those effects until supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_CLOUD_AGENTCreate a persistent Railway cloud agent in an environment, optionally from a checkpoint or repository source, with optional region and public code endpoint. Returns identity and lifecycle metadata only. This action does not accept raw variable values. Creation can provision a running machine.

Input Parameters

string
Optional cloud-agent name.
string
Machine region, such as us-west2. Defaults to the checkpoint region, otherwise the workspace’s preferred region.
object
Optional repository to clone into the agent workspace.
object
Opt-in public code endpoint; pass {} to use its default port. Omit to disable, including when restoring a checkpoint.
string
required
Environment ID in which to create the cloud agent.
string
Existing checkpoint from which to create the cloud agent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_CLOUD_AGENT_CHECKPOINTCheckpoint the agent’s disk. Poll cloudAgentCheckpoint until SUCCEEDED.

Input Parameters

string
required
Railway id ID required by cloud agent checkpoint create.
string
Name supplied to cloud agent checkpoint create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_CLOUD_AGENT_FEEDBACKSend lightweight agent feedback to Railway. Returns the report ID after delivery.

Input Parameters

object
required
Structured parameters for cloud agent feedback create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_DEPLOYMENT_INSTANCE_EXECUTIONInvoke a deployment instance execution.

Input Parameters

object
required
Structured parameters for deployment instance execution create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_DEPLOYMENT_TRIGGERCreates a deployment trigger.

Input Parameters

object
required
Structured parameters for deployment trigger create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_DOMAINCreate either a generated railway.app domain or a caller-owned custom domain. Custom-domain responses can include DNS setup records and Railway’s verification token and state when available.

Input Parameters

string
Caller-owned hostname. Required for custom domains and invalid for generated Railway domains.
string
Project ID. Required for custom domains and invalid for generated Railway domains.
string
required
Target service ID.
string ("railway" | "custom")
required
Type of domain to create: a generated railway.app domain or a caller-owned custom domain.
integer
Service port to which the domain should route.
string
required
Target environment ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_EGRESS_GATEWAY_ASSOCIATIONCreate a new egress gateway association for a service instance

Input Parameters

object
required
Structured parameters for egress gateway association create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_ENVIRONMENTCreate an empty Railway environment or clone an existing environment, with explicit initial-deployment and change-staging behavior.

Input Parameters

string
required
Name of the new environment.
boolean
Whether the new environment is ephemeral.
string
required
Project ID in which to create the environment.
boolean
Whether to skip initial deployments when changes are committed immediately.
string
Environment ID whose services, volumes, configuration, and variables will be cloned. Omit to create an empty environment.
boolean
Whether to leave the environment’s initial changes staged instead of committing them immediately.
boolean
Whether to apply initial changes asynchronously and return immediately. False waits for changes to be applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_INTEGRATIONCreate an integration for a project

Input Parameters

object
required
Structured parameters for integration create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_JOB_APPLICATIONCreates a new job application.

Input Parameters

object
required
Structured parameters for job application create.
object
required
Resume supplied to job application create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_NOTIFICATION_RULECreate a new notification rule

Input Parameters

object
required
Structured parameters for notification rule create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_OBSERVABILITY_DASHBOARDCreate an observability dashboard

Input Parameters

object
required
Structured parameters for observability dashboard create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_OR_GET_PRIVATE_NETWORKDeprecated by Railway: Removed. Private networks and endpoints are managed by the platform; enable private networking on the environment instead. Removed. Private networks and endpoints are managed by the platform; enable private networking on the environment instead.

Input Parameters

object
required
Structured parameters for private network create or get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_OR_GET_PRIVATE_NETWORK_ENDPOINTDeprecated by Railway: Removed. Private networks and endpoints are managed by the platform; enable private networking on the environment instead. Removed. Private networks and endpoints are managed by the platform; enable private networking on the environment instead.

Input Parameters

object
required
Structured parameters for private network endpoint create or get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_PLUGINCreates a new plugin in Railway for the specified project. Use this action when you need to add a custom plugin to a Railway project, such as for integrating external services or extending project functionality. The action requires a valid project ID (found in the Railway dashboard URL) and a descriptive name for the plugin. The plugin will be created with default settings and can be further configured after creation.

Input Parameters

string
required
The name of the plugin to create. This should be a descriptive identifier for the plugin.
string
required
The ID of the project to create the plugin in. The project ID can be found in the Railway dashboard URL or via the Railway API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_PROJECTCreate a Railway project in an accessible workspace and return its project and default-environment IDs. Optionally connect a repository branch for deployment and configure the runtime, public visibility, and pull-request deployment settings.

Input Parameters

string
required
Project name.
string
Optional connected repository in owner/name form.
string
Repository branch to deploy. Required when repo is provided.
string ("LEGACY" | "UNSPECIFIED" | "V2")
Validated Railway runtime enum value.
boolean
Whether the project is public.
boolean
Whether pull-request deployments are enabled.
string
Project description.
string
required
Workspace ID in which to create the project.
string
Name for the initial environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_PROJECT_INVITATIONCreate an invitation for a project

Input Parameters

string
required
Railway id ID required by project invitation create.
object
required
Structured parameters for project invitation create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_RAILWAY_DOMAIN_DNS_RECORDCreate a DNS record for a Railway domain

Input Parameters

object
required
Structured parameters for railway domain dns record create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_RAILWAY_DOMAIN_EMAIL_FORWARDING_RULEForward an address on this domain to an external inbox

Input Parameters

object
required
Structured parameters for railway domain email forwarding rule create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_SANDBOXCreate a Railway sandbox in an environment, optionally forking a running sandbox or building/restoring a template. Configure resources, idle timeout, networking and public domains. Returns lifecycle and domain metadata; does not wait for RUNNING. Environment-variable value inputs are not supported.

Input Parameters

string
Sandbox placement region, e.g. us-west2; omission uses the platform default.
object
Build or restore a template without supplying environment-variable values; mutually exclusive with source_sandbox_id.
object
Creation-time CPU and memory, also applied to forks and checkpoint restores.
string
required
Environment ID in which to create the sandbox.
array
Up to ten public HTTP routes, one per unique prefix and port; requires explicit PRIVATE networking.
string ("ISOLATED" | "PRIVATE")
Defaults to ISOLATED (public NAT egress only). PRIVATE joins the environment network and must be explicit for public domains.
string
Fork a running sandbox in the same environment; mutually exclusive with template.
integer
Inactivity minutes before destruction; <=0 disables idle destruction (plan-gated). Omission uses the plan default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_SANDBOX_CHECKPOINTCapture a running sandbox’s current disk into a reusable, named checkpoint. Synchronous: the checkpoint is ready when this returns.

Input Parameters

string
required
Name supplied to sandbox checkpoint create.
string
required
Railway sandbox ID required by sandbox checkpoint create.
string
required
Railway environment ID required by sandbox checkpoint create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_SERVICECreate an empty, repository-backed, image-backed, or template-backed service in a Railway project.

Input Parameters

string
Railway service icon value.
string
Service name.
string
Repository branch. Allowed only with a repository source.
object
Exactly one repository or container-image source.
object
Initial variable name/value map for the service.
string
required
Project ID in which to create the service.
string
Template ID. Must be supplied together with template_service_id.
string
Environment ID for initial service configuration. A fork limits creation to that environment; otherwise Railway creates the service in non-fork environments.
string
Service ID in the template serialized configuration. Requires template_id.
object
Private container-registry credentials. Allowed only with an image source and subject to Railway plan availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_SIGNALRegister a new signal for an owner scope.

Input Parameters

object
required
Structured parameters for signal create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_TCP_PROXYDeprecated by Railway: Use staged changes and apply them. Creating a TCP proxy with this endpoint requires you to redeploy the service for it to be active. Creates a new TCP proxy for a service instance.

Input Parameters

object
required
Structured parameters for tcp proxy create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_TRUSTED_DOMAINCreate a new trusted domain for this workspace

Input Parameters

object
required
Structured parameters for trusted domain create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_VOLUMECreate a persistent Railway volume and optionally attach it to one service and environment. This action creates billable persistent state and does not clean it up; deletion is a separate DELETE_VOLUME action that requires workspace-admin authorization when using OAuth.

Input Parameters

string
Railway region in which to create the volume.
string
required
Absolute path at which the volume will be mounted.
string
required
Project ID in which to create the persistent volume.
string
Service ID for the initial attachment. Must be supplied together with environment_id; omit both to create an unattached volume.
string
Environment ID for the initial attachment. Must be supplied together with service_id; omit both to create an unattached volume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_CREATE_VOLUME_BACKUPStart an asynchronous backup of a Railway volume instance, optionally assigning a name (default Manual). Supply the volume instance ID, not its parent volume ID. Manual backups require a Pro workspace. Returns a nullable workflow ID; acceptance does not confirm backup completion.

Input Parameters

string
Optional backup name or label. Omission uses Railway’s default label, Manual.
string
required
ID of the volume instance to back up, not the parent volume ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_ACCESS_GROUPDelete an access group. This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by access group delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_CLOUD_AGENTDelete a Railway cloud agent by ID. This is a destructive operation; use only for an agent you intend to remove and requires confirm=true. Returns the provider’s Boolean result: true confirms success, while false does not confirm deletion.

Input Parameters

string
required
ID of the Railway cloud agent to delete.
boolean
required
Must explicitly be true to confirm cloud-agent deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_CLOUD_AGENT_CHECKPOINTDelete a checkpoint. This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by cloud agent checkpoint delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_DEPLOYMENTPermanently delete a completed Railway deployment from deployment history and stop any remaining project usage from it. This does not delete the service, is irreversible, and requires confirm=true.

Input Parameters

boolean
required
Must be true to confirm permanent removal from deployment history.
string
required
Deployment ID to permanently remove from Railway history.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_DEPLOYMENT_TRIGGERDeletes a deployment trigger. This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by deployment trigger delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_DOMAINPermanently delete one generated Railway domain or custom domain by ID after explicit confirmation.

Input Parameters

boolean
required
Must be true to confirm permanent domain deletion.
string
required
Domain ID to delete.
string ("railway" | "custom")
required
Kind of domain to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_ENVIRONMENTPermanently delete one Railway environment and its deployments. This action is irreversible, requires confirm=true, and requires workspace-admin authorization when using OAuth. Reconnect with a separately selected workspace:admin grant if Railway returns Not Authorized.

Input Parameters

boolean
required
Must be true to confirm irreversible environment and deployment deletion.
string
required
Environment ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_INTEGRATIONDelete an integration for a project This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by integration delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_NOTIFICATION_RULEDelete a notification rule This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by notification rule delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_PLUGINDeprecated by Railway: Plugins are deprecated Deletes a plugin. This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by plugin delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.
string
Railway environment ID required by plugin delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_PRIVATE_NETWORK_ENDPOINTDeprecated by Railway: Removed. Private networks and endpoints are managed by the platform; enable private networking on the environment instead. Removed. Private networks and endpoints are managed by the platform; enable private networking on the environment instead. This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by private network endpoint delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_PRIVATE_NETWORKS_FOR_ENVIRONMENTDeprecated by Railway: Removed. Private networks and endpoints are managed by the platform; enable private networking on the environment instead. Removed. Private networks and endpoints are managed by the platform; enable private networking on the environment instead. This is destructive and requires confirm=true.

Input Parameters

boolean
required
Must explicitly be true to confirm this destructive Railway action.
string
required
Railway environment ID required by private networks for environment delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_PROJECTPermanently delete one Railway project and its resources. This action is irreversible and requires explicit confirm=true. OAuth requires a workspace:admin grant for the selected workspace and a user with the Admin role.

Input Parameters

boolean
required
Must explicitly be true to confirm irreversible project deletion.
string
required
ID of the Railway project to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_PROJECT_INVITATIONDelete an invitation for a project This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by project invitation delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_PROJECT_SCHEDULEDeletes a project with a 48 hour grace period. This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by project schedule delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_RAILWAY_DOMAIN_DNS_RECORDDelete a DNS record for a Railway domain This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for railway domain dns record delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_RAILWAY_DOMAIN_EMAIL_FORWARDING_RULEStop forwarding an address on this domain This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for railway domain email forwarding rule delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_SANDBOX_CHECKPOINTDelete a sandbox checkpoint. This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by sandbox checkpoint delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.
string
required
Railway environment ID required by sandbox checkpoint delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_SERVICEPermanently delete a Railway service; requires confirm=true. With environment_id, delete only in that environment; the service itself is deleted once no instances remain. Without it, delete in every environment that is not a fork. Requires member access to the selected project or workspace.

Input Parameters

boolean
required
Must be true to confirm irreversible service deletion.
string
required
Service ID to delete.
string
Delete only in this environment. The service itself is deleted once no instances remain. Omit to delete in every non-fork environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_SIGNALDelete a signal and its audit log. This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for signal delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_TCP_PROXYDeletes a TCP proxy by id This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by tcp proxy delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_TEMPLATEDelete a Railway template by ID, optionally in a workspace context. This is a destructive operation requiring confirm=true and permission to manage the template. Returns the provider’s Boolean result: true confirms success; false does not confirm deletion.

Input Parameters

string
required
ID of the Railway template to delete.
boolean
required
Must explicitly be true to confirm template deletion.
string
Optional workspace ID for the template deletion context. Omit for the provider’s default context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_TRUSTED_DOMAINDelete a trusted domain This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by trusted domain delete.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_VARIABLEDelete a Railway environment variable. This action uses the variableDelete GraphQL mutation to permanently remove an environment variable from a project, environment, or service. This action is irreversible — once deleted, the variable cannot be recovered.

Input Parameters

string
required
The name of the environment variable to delete
string
required
The unique identifier of the project containing the environment
string
The unique identifier of the service. If not provided, variables will be deleted at the environment level
string
required
The unique identifier of the environment containing the variable

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_VOLUMEPermanently delete a persistent volume and all its associated data from Railway. Use when you need to remove a volume that is no longer needed. This action is irreversible — the volume and all its data will be permanently deleted and cannot be recovered once removed. Use this action when: - Cleaning up unused volumes to reduce storage costs - Removing volumes associated with deprecated environments - Deleting volumes before removing a project

Input Parameters

string
required
The unique identifier of the volume to delete. Obtain this ID from the list volumes endpoint or the volume creation response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_VOLUME_INSTANCE_BACKUPDeletes volume instance backup This is destructive and requires confirm=true.

Input Parameters

boolean
required
Must explicitly be true to confirm this destructive Railway action.
string
required
The volume instance’s id
string
required
The volume instance’s backup id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DELETE_WORKSPACEDelete a Railway workspace and all data associated with it. This action uses the workspaceDelete GraphQL mutation to permanently remove a workspace. Use this action when you need to permanently delete a workspace that is no longer needed. This action is irreversible — once deleted, the workspace and all its associated projects, environments, and data cannot be recovered.

Input Parameters

string
required
The unique identifier of the workspace to delete. Example: ‘abc123-def4-5678-ghij-klmnopqrstuv’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DEPLOY_CLOUD_AGENTBuild the agent’s code inside its own VM and deploy it. Creates the named service (default: the agent’s name) or reuses it. Needs an agent booted with the builder.

Input Parameters

string
required
Railway id ID required by cloud agent deploy.
string
Path supplied to cloud agent deploy.
string
Replicas per region, e.g. { “us-west2”: 3 }. Saved on the service; omit to keep its current regions.
string
Service name supplied to cloud agent deploy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DEPLOY_ENVIRONMENT_TRIGGERSDeploys all connected triggers for an environment.

Input Parameters

object
required
Structured parameters for environment triggers deploy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DEPLOY_GITHUB_REPODeploys a GitHub repo

Input Parameters

object
required
Structured parameters for github repo deploy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DEPLOY_SERVICEStart a Railway deployment from a service’s already connected repository or image source, optionally at a repository commit SHA, and return the deployment ID. This action cannot access or upload local files; connect the source to the service before calling it.

Input Parameters

string
Commit SHA from the service’s connected repository. Omit to deploy the current connected source. This field does not accept a local path or file.
string
required
Service ID whose already connected source Railway should deploy.
string
required
Target environment ID for the deployment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DEPLOY_SERVICE_INSTANCEDeploy a service instance

Input Parameters

string
Commit sha supplied to service instance deploy.
string
required
Railway service ID required by service instance deploy.
boolean
Latest commit supplied to service instance deploy.
string
required
Railway environment ID required by service instance deploy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DEPLOY_TEMPLATEDeploy a complete Railway template configuration into a new project or an existing project environment. Railway commits the template changes and starts their deployments.

Input Parameters

string
Existing target project ID. Requires environment_id.
string
required
Template ID returned by GET_TEMPLATE.
string
Workspace ID in which Railway should create a new project. It may also be supplied with an existing project target.
string
Existing target environment ID. Requires project_id.
object
required
Complete serialized template configuration returned by GET_TEMPLATE, optionally customized while preserving its required structure.
string
Existing service to use as the template cluster root. Provide this only with both project_id and environment_id; it cannot be used with a workspace-only target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DEPLOY_TEMPLATE_LEGACYDeprecated by Railway: Deprecated in favor of templateDeployV2 Deploys a template.

Input Parameters

object
required
Structured parameters for template deploy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DESTROY_SANDBOXDestroy a Railway sandbox by ID in an environment. This is destructive: the sandbox can no longer run commands and requires confirm=true. Returns nullable sandbox lifecycle metadata; the returned status may reflect destruction still in progress.

Input Parameters

string
required
ID of the sandbox to destroy.
boolean
required
Must explicitly be true to confirm sandbox destruction.
string
required
ID of the environment containing the sandbox to destroy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DETACH_ACCESS_GROUP_PROJECTDetach a project from an access group. This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for access group project detach.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DISABLE_PITR_FOR_HA_CLUSTERDisables point-in-time recovery on an HA database cluster with the same rolling rollout as enable. The backup bucket is left intact, so existing backup history is preserved.

Input Parameters

object
required
Structured parameters for disable pitr for ha cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DISABLE_SERVICE_CDNDisables CDN for a service, soft-deleting the edge config.

Input Parameters

object
required
Structured parameters for disable service cdn.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DISCONNECT_SERVICEDisconnect a service from a repo This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by service disconnect.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DISCONNECT_USER_DISCORDDisconnects the authenticated user’s Railway account from Discord. Use when you need to unlink a Discord account that was previously connected to Railway for notifications, authentication, or team management. This action is irreversible for the disconnect operation — the user must manually reconnect through the Railway dashboard or Discord OAuth flow if needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_DISMISS_SERVICE_INSTANCE_VULN_REMEDIATIONDismiss a pending database security update and cancel its scheduled redeploy.

Input Parameters

string
required
Railway service ID required by service instance vuln remediation dismiss.
string
required
Railway environment ID required by service instance vuln remediation dismiss.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_EJECT_TEMPLATE_SERVICE_SOURCEEjects a service from the template and creates a new repo in the provided org.

Input Parameters

object
required
Structured parameters for template service source eject.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ENABLE_PITR_FOR_HA_CLUSTEREnables point-in-time recovery on an HA database cluster (Postgres HA, MySQL HA) with a rolling, near-zero-downtime rollout across its members. Safe to retry.

Input Parameters

object
required
Structured parameters for enable pitr for ha cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ENABLE_SERVICE_CDNEnables CDN for a service, creating an edge config and attaching all live domains.

Input Parameters

object
required
Structured parameters for enable service cdn.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ESTIMATE_VOLUME_POINT_IN_TIME_RESTOREEstimate disk space needed for a Railway volume point-in-time restore at a target timestamp, optionally using a specific backup history. Returns base backup label, data/WAL/scratch sizes in MB, plan maximum size and a likely-to-fit Boolean. Returns estimate:null when unavailable. This is a conservative estimate, not a recovery guarantee. Read-only: does not restore, provision or change billing.

Input Parameters

string
Source backup history path from the backup history picker. Omit or pass null to use the current history.
string
required
Point-in-time target as an ISO 8601 DateTime.
string
required
Source volume instance ID to estimate restoring from; distinct from the parent volume ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_EXEC_SANDBOX_COMMANDExecute a command inside a running Railway sandbox in the specified environment. Commands can modify the sandbox. Returns stdout, stderr, exitCode, timedOut and truncated; inspect these fields because successful API execution does not imply a successful or complete command. Do not use to access secrets or raw environment-variable values.

Input Parameters

string
required
ID of the running sandbox in which to execute.
string
required
Command to execute inside the running sandbox. Do not include secrets, read credentials, or read or assign raw environment-variable values.
integer
Optional execution timeout in seconds. Omit to use Railway’s default; provider determines supported values.
string
required
Environment ID containing the running sandbox.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_FORCE_DELETE_PROJECT_SCHEDULEForce delete a scheduled deletion of a project (skips the grace period) This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by project schedule delete force.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_FORK_CLOUD_AGENTDuplicate a running cloud agent.

Input Parameters

string
required
Railway id ID required by cloud agent fork.
string
Name supplied to cloud agent fork.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GENERATE_TEMPLATEGenerate a template for a project

Input Parameters

object
required
Structured parameters for template generate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_AGENT_USAGEGet unified AI usage for a Railway workspace, including total usage in cents, billing period end, available soft/hard limits and remaining usage. This is a read-only billing summary: it does not change spending limits or payments.

Input Parameters

string
required
ID of the workspace whose unified AI usage to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_ALL_PLATFORM_FEATURE_FLAGSReturns the platform feature flags enabled for the current user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_AUDIT_LOGGet metadata for a Railway audit log entry by entry ID and workspace ID: event type, creation time and associated workspace/project/environment identifiers. Returns metadata only; unstructured event payload and context are not included. Audit logs are available to workspace admins.

Input Parameters

string
required
ID of the audit log entry to retrieve.
string
required
Workspace ID containing the audit log entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_BUCKET_INSTANCE_DETAILSGet object count and storage size for a Railway bucket instance.

Input Parameters

string
required
Railway bucket ID required by bucket instance details.
string
required
Railway environment ID required by bucket instance details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_BUILD_LOGSReturn a bounded, optionally filtered time window of build-phase logs for one Railway deployment.

Input Parameters

integer
Maximum number of build log entries to return (1-500).
string
Railway log query, such as text search or @level:error.
string
Inclusive ISO 8601 end time; omit to include logs through the current time.
string
Inclusive ISO 8601 start time; omit to use Railway’s earliest available time.
string
required
Deployment ID whose build-phase logs to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_CHANGELOG_BLOCK_IMAGEGets the image URL for a Notion image block

Input Parameters

string
required
Railway id ID required by changelog block image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_CLOUD_AGENTGet a Railway cloud agent by ID within an environment, including its lifecycle, network endpoints, repository source, and session work status. Returns cloudAgent: null when the agent belongs to another environment. Does not wake or modify the agent.

Input Parameters

string
required
ID of the Railway cloud agent to retrieve.
string
required
Environment ID containing the agent. An agent in a different environment returns null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_CLOUD_AGENT_CHECKPOINTGet a Railway cloud agent’s disk-checkpoint metadata by checkpoint ID, including capture status, failure reason, creation time, region and project/environment restrictions. A null environmentId permits booting anywhere in the project. Poll this lookup after checkpoint creation until status is SUCCEEDED or FAILED. Reads metadata only; does not create, restore or download the checkpoint.

Input Parameters

string
required
ID of the cloud agent disk checkpoint to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_CLOUD_AGENT_TASKRead Railway cloud-agent task metadata without waking the VM: the latest turn in a session, or an earlier task_id. Returns task/session identity, status, model settings, completion time, progress counters, active tool names and pending interaction identifiers/actions. Excludes task text, result content, attachments, JSON metadata, form fields and tool arguments. Does not submit or respond to a task.

Input Parameters

string
Earlier task turn ID in this session; omit to read the latest turn.
string
required
Coding-agent session ID to inspect.
string
required
Cloud-agent ID containing the task session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_COMPLIANCE_AGREEMENTSGet compliance agreements for a workspace including HIPAA BAA and GDPR DPA status.

Input Parameters

string
required
Railway workspace ID required by compliance agreements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_CUSTOM_DOMAINRead one Railway custom domain by domain ID and project ID using customDomain.status. Returns identity, routing port, synchronization, verification state, DNS record metadata and public certificate status, including certificateRetryable. Does not retry issuance or modify DNS. Verification tokens, DNS record values, private keys and free-text certificate errors are excluded.

Input Parameters

string
required
Custom-domain ID to retrieve.
string
required
Project ID containing the custom domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_CUSTOM_DOMAIN_AVAILABLEChecks if a custom domain is available.

Input Parameters

string
required
Domain supplied to custom domain available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_DATABASE_PASSWORD_ROTATION_PROGRESSProgress of the HA password rotation running for a cluster, or null when none is.

Input Parameters

string
required
Railway service ID required by database password rotation progress.
string
required
Railway environment ID required by database password rotation progress.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_DEPLOYMENTReturn one deployment’s status, timestamps, metadata, and rollback eligibility.

Input Parameters

string
required
Deployment ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_DEPLOYMENT_LOGSRetrieve runtime logs for a deployment. Use when you need to view the runtime application logs for troubleshooting runtime issues, monitoring application behavior, or debugging errors that occur during deployment execution. This action queries the Railway GraphQL API for runtime log entries associated with the specified deployment ID. The logs are returned in reverse chronological order (most recent first).

Input Parameters

integer
Maximum number of log entries to retrieve. Defaults to 25.
string
required
The unique identifier of the deployment to retrieve runtime logs for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_DEV_NEW_LANDING_TARGETThe cloud agent ssh dev.new lands you in, or null when the next connection will create one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_DNS_QUERY_LOGSFetch individual DNS query logs for a Railway environment, optionally filtering by service or deployment-instance/sandbox ID and DNS log-query expression. Use anchor and before/after dates and limits to select a window. Returns queried name, record type, response code, answer IPs, ordered CNAME chain, timestamp, internal/external zone and resource identifiers. Returns one window without a pagination cursor; does not perform DNS queries or return aggregated metrics.

Input Parameters

string
DNS log-filter expression, e.g. @rcode:NXDOMAIN @qtype:A @domain:example.com @status:failed. Prefix a term with - to exclude it; repeat a key to match any of its values.
string
Latest date to look for logs after the anchor.
string
Optional service ID filter.
integer
Maximum number of logs returned after the anchor.
string
Target date and time around which to retrieve logs.
string
Oldest date to look for logs before the anchor.
integer
Maximum number of logs returned before the anchor.
string
required
Environment ID whose DNS query logs to retrieve.
string
Optional deployment-instance or sandbox ID filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_DOMAIN_STATUSDeprecated by Railway: Use the status field within the domain query instead Domain with status

Input Parameters

string
required
Railway id ID required by domain status.
string
required
Railway project ID required by domain status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_ENVIRONMENTGet details of a specific Railway environment by its ID, including service instances and deployment information. Use this action when you need to retrieve detailed information about an environment, such as its name, creation timestamp, and the service instances deployed within it, along with their latest deployment statuses. This is a read-only action that queries the Railway GraphQL API.

Input Parameters

string
required
The unique identifier of the environment to retrieve. Example: ‘abc123-def4-5678-ghij’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_ENVIRONMENT_CHANGE_SET_APPLYGet the status or completed result metadata of an asynchronous RailwayChangeSet apply by environment ID and apply ID. Returns status, related resource IDs and per-operation kind/path/status. Omits diagnostics, operation output blobs and free-form summaries. Read-only: does not apply or modify configuration. Call again with the same IDs to check progress; performs one lookup per call.

Input Parameters

string
required
ID returned for the asynchronous RailwayChangeSet apply to inspect.
string
required
ID of the environment where the asynchronous change-set apply was started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_ENVIRONMENT_LOGSFetch a window of Railway project-environment logs, with optional anchor, before/after date boundaries, separate before/after limits and a log-filter query. Build logs are excluded unless the filter explicitly includes a snapshot ID. Returns timestamp, message, severity, structured attributes and resource tags. This is a single log window, not a live stream; the provider returns no pagination cursor.

Input Parameters

string
Railway log-filter query syntax. Build logs are excluded unless a snapshot ID is explicitly supplied in this filter.
string
Latest date to look for logs after the anchor.
integer
Maximum number of logs to return after the anchor.
string
Target date and time around which to retrieve logs.
string
Oldest date to look for logs before the anchor.
integer
Maximum number of logs to return before the anchor.
string
required
Environment ID for which to retrieve logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_ENVIRONMENT_PATCHGet a Railway environment patch by ID, returning lifecycle metadata: status, environment ID, timestamps, message and last application error. Does not return the configuration patch or raw variable values, and does not apply, commit or modify the patch.

Input Parameters

string
required
Environment patch ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_ENVIRONMENT_STAGED_CHANGESGet metadata for the latest staged commit in a Railway environment: patch ID, lifecycle status, timestamps and environment identity/name. Metadata only: does not return the patch JSON, variable values, change details or free-text errors/messages, and cannot enumerate changed variable names from the opaque patch. Does not commit or apply changes.

Input Parameters

string
required
Environment ID whose latest staged commit metadata to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_ESTIMATED_USAGERead Railway’s end-of-current-billing-cycle usage estimates for requested measurements, optionally selecting a project or workspace and including deleted projects. Returns estimated values per project and measurement, not an invoice or guaranteed charge. This schema accepts no date range; does not change billing settings, subscriptions or payments.

Input Parameters

string
Optional project ID to select usage estimates for.
array
required
Railway resource measurements to estimate, such as CPU_USAGE, MEMORY_USAGE_GB, or NETWORK_TX_GB.
string
Optional workspace ID to select usage estimates for.
boolean
Whether to include deleted projects in estimates; omit to use the provider default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_FUNCTION_RUNTIMEGet information about a specific Railway function runtime, including its image, latest version and available version images/tags. Currently bun is the only supported runtime name. Read-only; does not create or deploy a function.

Input Parameters

string
required
Function runtime name. Railway currently supports bun.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_GITHUB_IS_REPO_NAME_AVAILABLECheck if a repo name is available

Input Parameters

string
required
Full repo name supplied to github is repo name available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_GIT_HUB_PR_INFOGet information for a GitHub pull request associated with a Railway service, including its title, state, body, author, change counts, and mergeability. A null result or certain errors indicating no linked GitHub repository return empty fields.

Input Parameters

integer
required
The pull request number (e.g., 1 for PR #1).
string
required
The unique identifier of the Railway service to get the PR info for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_GITHUB_PR_INFO_RESULTGet info for a GitHub pull request, including fetch errors

Input Parameters

integer
required
Pr number supplied to github pr info result.
string
required
Railway service ID required by github pr info result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_GITHUB_REPOChecks if user has access to GitHub repository

Input Parameters

string
required
Full repo name supplied to github repo.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_GIT_HUB_REPO_ACCESS_AVAILABLEChecks if user has access to GitHub repository

Input Parameters

string
required
Full repo name supplied to git hub repo access available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_GITHUB_REPO_BRANCHESGet branches for a GitHub repo that the authenticated user has access to

Input Parameters

string
required
Repo supplied to github repo branches.
string
required
Owner supplied to github repo branches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_HTTP_LOGSReturn a bounded date-anchor window of HTTP request logs for one deployment, including request, response, timing, and routing fields.

Input Parameters

string
Railway HTTP log filter using fields such as @method, @httpStatus, @path, or @requestId.
string
Inclusive ISO 8601 lower boundary for the log window.
integer
Maximum entries after the date anchor to return (1-1000).
string
ISO 8601 anchor around which Railway returns before and after entries.
string
Inclusive ISO 8601 upper boundary for the log window.
integer
Maximum entries before the date anchor to return (1-1000).
string
required
Deployment ID whose HTTP request logs to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_HTTP_METRICSReturn either HTTP request counts grouped by status code or p50/p90/p95/p99 response-time series for one Railway service and environment. Status counts are returned as evidence and are not converted into an error percentage.

Input Parameters

string
Exact HTTP request path filter accepted by Railway.
string
Exact HTTP method filter accepted by Railway, such as GET or POST.
string ("status_counts" | "response_time")
required
Metric view: status_counts returns request-count series grouped by HTTP status, while response_time returns p50/p90/p95/p99 duration series.
string
required
Inclusive ISO 8601 metric end time.
string
required
Service ID whose HTTP metrics to return.
string
required
Inclusive ISO 8601 metric start time.
integer
HTTP status filter for response_time only (100-599).
integer
Sample interval in seconds; must be positive when provided.
string
required
Environment ID containing the service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_HTTP_REQUEST_METRICSRead HTTP request-count time-series samples for a Railway service and environment over an explicit start/end period, using query.httpMetrics. Optionally filter by HTTP method, request path or status code and set sample frequency in seconds. Returns Unix-second timestamps and request counts, not request logs, duration percentiles or error-rate breakdowns.

Input Parameters

string
Optional request path filter; avoid supplying credentials or secret-bearing query strings.
string
Optional HTTP method filter, e.g. GET or POST.
string
required
ISO 8601 end of the metrics period.
string
required
Service ID whose HTTP request counts to retrieve.
string
required
ISO 8601 start of the metrics period.
integer
Optional HTTP response status code filter, e.g. 200, 404 or 500.
integer
Frequency of data points in seconds. Omit to choose the smallest provider-valid interval that returns at most 1,000 samples.
string
required
Environment ID containing the service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_MYSQL_PITR_RESTORABLE_WINDOWThe point-in-time window a MySQL service’s binlog archive can restore to, resolved from the archive bucket: the oldest full backup (floor), the newest shipped binlog (ceiling) and every full backup’s timestamp. archiveConfigured is false when the service carries no complete BINLOG_ARCHIVE_* contract.

Input Parameters

string
required
Railway service ID required by mysql pitr restorable window.
string
required
Railway environment ID required by mysql pitr restorable window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_NETWORK_FLOW_LOGSFetch individual Railway network flow logs for an environment around an optional time anchor. Bound logs before and after the anchor with dates and limits; optionally filter by service, deployment instance/sandbox, or Railway flow expression. Returns typed traffic metadata: addresses, ports, protocols, peers, counts, latency, capture times and drop reason. Does not retrieve packet payloads or change network policy. Returns one requested window; the provider exposes no cursor or pageInfo.

Input Parameters

string
Railway network flow filter expression, for example @protocol:tcp @direction:egress @dropped:true.
string
Latest date to look for logs after the anchor.
string
Optional service ID filter.
integer
Limit on the number of logs returned after the anchor.
string
Target date/time around which to look for logs.
string
Oldest date to look for logs before the anchor.
integer
Limit on the number of logs returned before the anchor.
string
required
Environment ID whose network flow logs to retrieve.
string
Optional deployment instance or sandbox ID filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_NOTIFICATION_DELIVERYGets a notification delivery by ID for the authenticated user

Input Parameters

string
required
Railway id ID required by notification delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PITR_HA_CLUSTER_REPLICATION_HEALTHLive replication health for an HA database cluster (Postgres HA, MySQL HA). Use it to gate the Enable/Disable PITR buttons so a rollout can’t start while a member is too far behind to rejoin. Returns null when the service isn’t an HA root.

Input Parameters

string
required
Railway environment ID required by pitr ha cluster replication health.
string
required
Railway root service ID required by pitr ha cluster replication health.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PITR_HA_WORKFLOW_PROGRESSOne-shot read of the current progress of a PITR enable/disable rollout on an HA database cluster. Use it to rehydrate state on page load, then poll this field for updates. Returns null when no rollout has run recently.

Input Parameters

string
required
Railway environment ID required by pitr ha workflow progress.
string
required
Railway root service ID required by pitr ha workflow progress.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PLATFORM_STATUSGet Railway’s current platform status, including its stability flag and any reported incident or maintenance details. This is platform-wide status, not the health of a particular service or deployment. Requires no input parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PLUGINDeprecated by Railway: Plugins are deprecated Get a plugin by ID.

Input Parameters

string
required
Railway id ID required by plugin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PLUGIN_LOGSDeprecated by Railway: Plugins are deprecated Fetch logs for a plugin

Input Parameters

integer
Limit the number of logs returned (defaults 100, max 5000)
string
Filter logs by a string. Providing an empty value will match all logs.
string
End date supplied to plugin logs.
string
required
Railway plugin ID required by plugin logs.
string
Start date supplied to plugin logs.
string
required
Railway environment ID required by plugin logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PREFERENCESGet the email preferences for a user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PRIVATE_NETWORK_ENDPOINTGet a Railway service instance’s private-network endpoint using environment, private network and service IDs. Returns DNS names, private IP addresses, endpoint and service-instance IDs, synchronization status, tags and nullable lifecycle timestamps. The endpoint result may be null. This is a read-only lookup; it does not create endpoints, rename DNS records or modify private networking.

Input Parameters

string
required
Service ID whose private-network endpoint to retrieve.
string
required
Environment ID containing the service instance.
string
required
Private network ID to look up, using its publicId from privateNetworks discovery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PROJECT_COMPLIANCEGet comprehensive compliance information for a project including 2FA status, member permissions, backup schedules, and compliance agreements. Requires workspace API token with admin access.

Input Parameters

string
required
Railway project ID required by project compliance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PROJECT_RESOURCE_ACCESSGet resource access rules for project-specific actions

Input Parameters

string
required
Railway project ID required by project resource access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PROJECTS_BY_IDSFetch multiple projects by id. Skips ids the caller cannot access (does not throw on partial denial). Intended for batched dashboard hydration of a small viewport-sized set of cards.

Input Parameters

array
required
Ids supplied to projects by ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PROJECT_SERVICE_USAGEGet one page of usage grouped by project and service for a Railway workspace over a date-time interval and selected measurements. Optionally include deleted projects. first limits projects, not metric rows, to at most 50. To continue, pass page.pageInfo.endCursor as after with the same workspace, interval and measurements while page.pageInfo.hasNextPage is true. Does not modify billing or payment settings.

Input Parameters

string
Project ID cursor from the previous page’s endCursor.
integer
Number of projects to include in this page; maximum 50.
string
required
End of the usage interval as an ISO 8601 date-time.
string
required
Start of the usage interval as an ISO 8601 date-time.
array
required
Resource measurements to aggregate, such as CPU_USAGE, MEMORY_USAGE_GB, or NETWORK_TX_GB.
string
required
Workspace ID whose project and service usage to retrieve.
boolean
Whether to include deleted projects in usage. Omit to use Railway’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PROJECT_WORKSPACE_MEMBERSGet workspace members for a project with 2FA details

Input Parameters

string
required
Railway project ID required by project workspace members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_PUBLIC_STATSGet public Railway stats.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_RAILWAY_DOMAINGet a Railway domain by ID

Input Parameters

string
required
Railway id ID required by railway domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_RAILWAY_DOMAIN_BY_NAMEGet a Railway domain by its domain name within a workspace

Input Parameters

string
required
Domain supplied to railway domain by name.
string
required
Railway workspace ID required by railway domain by name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_RAILWAY_DOMAIN_EMAIL_FORWARDING_ELIGIBILITYWhether email forwarding can be offered on this domain, or why it can’t.

Input Parameters

string
required
Domain supplied to railway domain email forwarding eligibility.
string
required
Railway workspace ID required by railway domain email forwarding eligibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_RAILWAY_DOMAIN_EMAIL_FORWARDING_LIMITSCaps the forwarding UI surfaces before a rule is rejected server-side. Pass workspaceId for that workspace’s alias allowance; without it the highest plan’s is returned.

Input Parameters

string
Railway workspace ID required by railway domain email forwarding limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_REFERRAL_INFOGets the ReferralInfo for the authenticated user.

Input Parameters

string
required
Railway workspace ID required by referral info.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_RESOURCE_ACCESSGet resource access for the current user or workspace

Input Parameters

object
required
Explicit resource owner supplied to resource access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_RESOURCE_METRICSReturn sampled CPU, memory, disk, network, backup, or volume measurements for selected Railway resources and time range.

Input Parameters

string
Inclusive ISO 8601 end time. Omit to use the current time.
array
Current Railway MetricTag enum values used to group metric series.
string
Volume ID to select metrics for.
string
Project ID to select metrics for.
string
Service ID to select metrics for.
string
required
Inclusive ISO 8601 metric start time.
array
required
One or more current Railway MetricMeasurement enum values.
string
Environment ID to select metrics for.
integer
Sampling interval in seconds.
integer
Averaging window in seconds when computing CPU usage. Railway uses sample_rate_seconds when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_SANDBOXGet a Railway sandbox by ID in an environment, including lifecycle status, region, network isolation, idle timeout and public/private domains. Returns sandbox: null when the lookup returns no sandbox. Does not execute commands or modify the sandbox.

Input Parameters

string
required
ID of the Railway sandbox to retrieve.
string
required
ID of the environment containing the sandbox.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_SANDBOX_TEMPLATE_BUILDGet a template’s build state by id (the recipe content hash). READY once its checkpoint exists; BUILDING/FAILED reflect the build workflow.

Input Parameters

string
required
Railway id ID required by sandbox template build.
string
required
Railway environment ID required by sandbox template build.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_SERVICEGet a Railway service by ID, including its name, owning project, creation and update timestamps, icon, and source template service ID. Use List Services to discover service IDs.

Input Parameters

string
required
ID of the service to retrieve; use List Services to find service IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_SERVICE_AUTO_DEPLOY_STATUSGet auto-deploy status for a Railway service instance identified by project, environment and service IDs. Returns enabled (current setting), canEnable (enablement eligibility) and an optional provider reason. Reads both flags independently; does not enable or disable auto-deploy or start a deployment.

Input Parameters

string
required
Project ID containing the service.
string
required
Service ID whose auto-deploy status to retrieve.
string
required
Environment ID containing the service instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_SERVICE_INSTANCE_LIMIT_OVERRIDEGet explicit resource-limit overrides for a Railway service in an environment. Returns override:null when no overrides are set, rather than the effective limits merged with plan defaults. Exposes container CPU, memory bytes and process limit metadata when present. Read-only; does not allocate resources or change limits.

Input Parameters

string
required
ID of the service whose resource-limit overrides to retrieve.
string
required
ID of the environment containing the service instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_SERVICE_INSTANCE_LIMITSRead merged resource limits for a Railway service instance, including plan defaults. Returns container CPU, memory in bytes and process-ID limits when reported. These are configured limits, not current utilization measurements. Does not modify limits, change plans or expose an arbitrary provider JSON blob.

Input Parameters

string
required
Service ID whose merged resource limits to retrieve.
string
required
Environment ID containing the service instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_SIGNALFetch a single signal by owner scope and name.

Input Parameters

string
required
Name supplied to signal.
string
Owner supplied to signal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_SIGNAL_CHANGESRecent audit log entries for a signal.

Input Parameters

string
required
Name supplied to signal changes.
integer
Limit supplied to signal changes.
string
Owner supplied to signal changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_SIGNAL_EVALUATEEvaluate a signal against an evaluation context (pure resolution; does not mutate registry state).

Input Parameters

string
required
Name supplied to signal evaluate.
string
Owner supplied to signal evaluate.
string
required
Context supplied to signal evaluate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_TEAMDeprecated by Railway: Teams are now workspaces. Use the workspace query instead. Find a team by ID

Input Parameters

string
required
Railway id ID required by team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_TEAM_TEMPLATESDeprecated by Railway: Use templates instead - teams are now workspaces Get all templates for a team.

Input Parameters

integer
Maximum number of records to return from the corresponding side of team templates.
string
Pagination cursor used to continue team templates; obtain it from the previous page.
integer
Maximum number of records to return from the corresponding side of team templates.
string
Pagination cursor used to continue team templates; obtain it from the previous page.
string
required
Railway team ID required by team templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_TEMPLATEReturn a Railway template’s ID, name, and serialized configuration required for deterministic deployment.

Input Parameters

string
required
Template code returned by RAILWAY_SEARCH_TEMPLATES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_TEMPLATE_METRICSGet the metrics for a template.

Input Parameters

string
required
Railway id ID required by template metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_TEMPLATE_SOURCE_FOR_PROJECTGet the source template for a project.

Input Parameters

string
required
Railway project ID required by template source for project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_TRACEGet explicit metadata for spans of a Railway trace, oldest first, restricted to the specified environment. Includes span/parent IDs, service and deployment IDs, names, timing, component, kind and status code. Returns at most max_spans (default 1000, maximum 2000), with no continuation cursor. Omits arbitrary attributes, event/link payloads and free-form status messages. Read-only.

Input Parameters

string
required
W3C trace ID consisting of 32 hexadecimal characters.
integer
Maximum spans returned, at most 2000. Omit or pass null for Railway’s default of 1000.
string
required
Environment ID; only spans belonging to this environment are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_TRACING_STATUSRead per-service tracing activity for a Railway environment within tracing retention. Returns separate timestamps for spans exported by the edge and by each service’s app. Edge spans do not establish app instrumentation. A service absent from the list has produced no spans within retention; nullable timestamps mean no spans for that exporting hop in the window. Does not retrieve span payloads or enable tracing.

Input Parameters

string
required
Environment ID whose per-service tracing activity to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_USAGEGet aggregated Railway usage for selected measurements across a project, workspace, or the current user’s projects. Optionally choose a time range, grouping dimensions, and inclusion of deleted projects. Without start_date, Railway uses the project owner’s current billing period. Values use the selected measurement’s units; this does not calculate an invoice or modify billing settings. Returns the full aggregate list without pagination.

Input Parameters

string
End of the usage time range as a DateTime timestamp.
array
Dimensions to group aggregated usage by. By default usage is grouped over the entire project. Only grouping fields exposed by Railway’s MetricTags object are returned.
string
Optional project ID to scope usage to a single project.
string
Start of the usage time range as a DateTime timestamp. If omitted, Railway uses the project owner’s current billing period.
array
required
Measurements to aggregate, such as CPU_USAGE, MEMORY_USAGE_GB, or NETWORK_TX_GB. Values are measurement-specific, not universally currency.
string
Optional workspace ID to aggregate usage across its projects. With neither project_id nor workspace_id, Railway returns current-user usage.
boolean
Whether to include deleted projects in the usage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_USER_KICKBACK_EARNINGSGet the authenticated Railway user’s total kickback earnings. The amount may be null when earnings data is unavailable or the earnings query reports a processing problem.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_USER_PROFILEGet the public profile for a user

Input Parameters

string
required
Username supplied to user profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_USER_TEMPLATESDeprecated by Railway: Users don’t have personal templates anymore, they belong to their team now Get all templates for the current user.

Input Parameters

integer
Maximum number of records to return from the corresponding side of user templates.
string
Pagination cursor used to continue user templates; obtain it from the previous page.
integer
Maximum number of records to return from the corresponding side of user templates.
string
Pagination cursor used to continue user templates; obtain it from the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_VERCEL_INFOGet information about the user’s Vercel accounts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_VOLUME_INSTANCEGet metadata for a Railway volume instance by instance ID, not its parent volume ID. Returns lifecycle state, deletion flag, timestamps, sizes in MB, mount path, region and parent volume/environment/service identifiers. Service association and state may be null. Reads metadata only; does not read files, mount, resize, back up or modify the volume.

Input Parameters

string
required
Volume instance ID to retrieve, not the parent volume ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_WORKFLOW_STATUSGet the status of a Railway workflow by workflow ID, including an optional provider error. States are Complete, Error, NotFound and Running. NotFound is returned as workflow state, not an HTTP failure. This read-only lookup does not start, cancel or retry workflows. Call again with the same ID to check progress.

Input Parameters

string
required
ID of the Railway workflow to inspect, such as a workflowId returned in environment history.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_WORKSPACEGet a Railway workspace by ID, including its name, plan, timestamps, preferred region, and security settings. OAuth access is limited to workspaces selected during consent. Use LIST_PROJECTS to retrieve projects in the workspace.

Input Parameters

string
required
ID of the Railway workspace to retrieve; it must be accessible to the connected account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_WORKSPACE_POLICYGet the policies for a workspace

Input Parameters

string
required
Railway workspace ID required by workspace policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_WORKSPACE_USAGE_TOTALSGet workspace-wide sums of Railway’s UI usage rollup for selected measurements and an optional time period. Optionally include deleted projects that still bill. Returns aggregate measurement values rather than per-project rows. Read-only; does not change billing or payments. No pagination.

Input Parameters

string
Optional end of the usage period as an ISO 8601 DateTime.
string
Optional start of the usage period as an ISO 8601 DateTime.
array
required
Measurements to aggregate across the workspace.
string
Workspace ID; omit to use the provider’s authenticated context.
boolean
Whether to include deleted projects that still bill. Omit to use Railway’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_GET_X_AGENT_CLAIM_INFODetails for the X build claim page: the build, whether it can be claimed, and whether the caller’s connected X account owns it.

Input Parameters

string
required
Railway build ID required by x agent claim info.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_IMPORT_DOCKER_COMPOSECreate services and volumes from docker compose

Input Parameters

string
required
Yaml supplied to docker compose import.
string
required
Railway project ID required by docker compose import.
string
required
Railway environment ID required by docker compose import.
boolean
Skip staging patch supplied to docker compose import.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_INITIATE_PROJECT_TRANSFERInitiate the transfer of project ownership

Input Parameters

object
required
Structured parameters for project transfer initiate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_INVITE_PROJECT_USERInvite a user by email to a project

Input Parameters

string
required
Railway id ID required by project invite user.
object
required
Structured parameters for project invite user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LEAVE_PROJECTLeave project as currently authenticated user This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by project leave.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LEAVE_USER_BETADeprecated by Railway: Use featureFlagRemove with PRIORITY_BOARDING. Unsubscribe from the Beta program. This is destructive and requires confirm=true.

Input Parameters

boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LEAVE_WORKSPACELeave a workspace This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by workspace leave.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_ADMIN_VOLUME_INSTANCES_FOR_VOLUMEGet all volume instances for a given volume

Input Parameters

string
required
Railway volume ID required by admin volume instances for volume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_API_TOKENSRetrieve API token metadata for the authenticated Railway user, including token IDs, names, and creation timestamps. A null token result is returned as an empty list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_AUDIT_EVENT_TYPESList all Railway audit log event type identifiers and their descriptions. Returns the event type catalog, not actual audit log records or user activity. Accepts no workspace filters or pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_AUDIT_LOGSList one cursor-paginated page of Railway workspace audit-log metadata. Requires workspace admin access. Optionally filter by time, event types, project or environment and choose sort order. Returns event IDs, types, timestamps, resource IDs and pageInfo; raw payload/context and actor details are excluded. Continue forward with endCursor as after or backward with startCursor as before, preserving filters and sort. Retention depends on the workspace plan.

Input Parameters

integer
Number of entries requested from the end of this page.
string ("asc" | "desc")
Sort order: asc or desc; omit for the provider default.
string
Forward pagination cursor from the previous page’s endCursor.
integer
Number of entries requested from the start of this page.
string
Backward pagination cursor from the following page’s startCursor.
object
Optional event type, project, environment and time filters.
string
required
Workspace ID whose audit logs to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_BOT_SCOPE_BINDINGSRailway agent chat bindings (Slack/Discord scope → workspace) across the caller’s workspaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_CLOUD_AGENT_CHECKPOINTSList one cursor-paginated page of Railway cloud-agent disk checkpoints in an environment, newest first. Returns checkpoint identity, capture status, region, optional failure reason and environment boot restriction, not disk contents. Continue forward with pageInfo.endCursor as after or backward with pageInfo.startCursor as before, keeping the same environment_id. Does not create checkpoints, restore disks or modify agents.

Input Parameters

integer
Number of entries requested from the end of this page.
string
Forward pagination cursor from the previous page’s endCursor.
integer
Number of entries requested from the start of this page.
string
Backward pagination cursor from the following page’s startCursor.
string
required
Environment ID whose cloud-agent checkpoints to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_CLOUD_AGENT_CONSOLE_SESSIONSList one page of resumable shell and exec sessions on a Railway cloud agent’s VM. Returns session names, kinds, attachment/foreground state, process lifecycle and native pageInfo cursors. Returns sessions:null if the agent has no running machine. Does not wake the machine, attach to sessions or execute commands. Command text and connection credentials are excluded.

Input Parameters

integer
Maximum edges from the end of the selected range; combine with before for backward paging.
string
Return edges after this provider cursor; use the previous page’s endCursor.
integer
Maximum edges from the start of the selected range; combine with after for forward paging.
string
Return edges before this provider cursor; use the previous page’s startCursor.
string
required
Cloud-agent ID whose VM console sessions to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_CLOUD_AGENTSList persistent coding cloud agents in an environment, including lifecycle and work status, networking, and repository source. Optionally filter by archive state or ownership. Returns the complete list without pagination.

Input Parameters

boolean
True returns only your agents. Omit to include teammates’ agents in the environment.
boolean
True returns only archived agents; false only unarchived agents. Omit to return both.
string
required
Environment ID whose cloud agents to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_CLOUD_AGENT_TASK_MODELSList the models Railway cloud-agent tasks can run on in a project environment, with provider/display names, supported reasoning efforts and the default model and reasoning effort for new conversations. Does not dispatch a task or change defaults.

Input Parameters

string
required
Project ID containing the environment.
string
required
Environment ID for which to list available task models.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_CLOUD_AGENT_TASKSList one page of Railway cloud-agent task records in an environment, newest first. Optionally filter by agent, task status, or one session’s turns (session_id requires cloud_agent_id). Returns typed lifecycle timestamps, IDs, model settings and correlation metadata. Excludes prompts, task output, error content, attachments, and JSON blobs. Continue with nextCursor as cursor, preserving environment and filters. Does not submit or modify tasks.

Input Parameters

integer
Number of tasks requested in this page; omit for the provider default.
string
Continuation cursor returned as nextCursor by the preceding page.
string ("AWAITING_INPUT" | "COMPLETED" | "FAILED" | "PENDING" | "RUNNING")
Optional task lifecycle status filter.
string
Restrict results to one session’s turns. Requires cloud_agent_id.
string
Optional agent ID to restrict the task list to one cloud agent.
string
required
Environment ID whose task records to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_DEPLOYMENT_INSTANCE_EXECUTIONSList one cursor-paginated page of Railway deployment-instance executions for a service in an environment. Returns execution/deployment IDs, lifecycle status, creation/update timestamps and nullable completion time. Excludes opaque deployment configuration metadata. Continue forward with pageInfo.endCursor as after or backward with pageInfo.startCursor as before, retaining service_id and environment_id. This is a read-only listing, not command execution.

Input Parameters

integer
Number of entries requested from the end of this page.
string
Forward pagination cursor from the preceding page’s endCursor.
integer
Number of entries requested from the start of this page.
string
Backward pagination cursor from the following page’s startCursor.
string
required
Service ID whose deployment-instance executions to list.
string
required
Environment ID containing the service’s deployment executions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_DEPLOYMENTSList one page of Railway deployments for a project, environment, or service, optionally filtered by status or deletion state.

Input Parameters

integer
Maximum number of deployments to return in this page.
string ("BUILDING" | "CRASHED" | "DEPLOYING" | "FAILED" | "INITIALIZING" | "NEEDS_APPROVAL" | "QUEUED" | "REMOVED" | "REMOVING" | "SKIPPED" | "SLEEPING" | "SUCCESS" | "WAITING")
Exact Railway deployment status to include.
string
Project ID filter. At least one project, environment, or service ID is required.
string
Service ID filter. At least one project, environment, or service ID is required.
string
Opaque cursor returned by the previous call; omit for the first page.
string
Environment ID filter. At least one project, environment, or service ID is required.
boolean
Whether to include deployments removed from deployment history.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_DEPLOYMENT_TRIGGERSList one page of deployment triggers for a Railway service in a project and environment. Returns repository, branch, provider and check-suite configuration. Use first/after for forward pagination or last/before for backward pagination with returned edge and pageInfo cursors. Does not trigger a deployment or modify configuration.

Input Parameters

integer
Maximum number of edges to return from the end of the window.
string
Return edges after this cursor, usually with first.
integer
Maximum number of edges to return from the start of the window.
string
Return edges before this cursor, usually with last.
string
required
Project ID containing the service.
string
required
Service ID whose deployment triggers to list.
string
required
Environment ID for the deployment triggers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_DOMAINSList Railway and custom domains for a service, including IDs, ports, DNS records, certificate state, and custom-domain verification token.

Input Parameters

string
required
Project ID containing the service.
string
required
Service ID whose domains to list.
string
required
Environment ID containing the service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_EGRESS_GATEWAYSList all egress gateways assigned to a Railway service instance identified by service and environment IDs. Returns gateway IPv4 addresses, regions and nullable zones. This is a read-only list: it does not allocate or assign gateways or change networking. The provider returns no pagination cursor.

Input Parameters

string
required
Service ID whose assigned egress gateways to list.
string
required
Environment ID containing the service instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_ENVIRONMENT_HISTORYList one cursor-paginated page of settled Railway environment history, newest first: system events and terminal operations. Filter by action, object, outcome, services, time, or dashboard activity-feed mode. Returns actor and change metadata without configuration payloads or variable values. Continue with pageInfo.endCursor as after when hasNextPage is true.

Input Parameters

string
Pagination cursor from the previous page’s endCursor.
integer
Number of entries to request in this page; omit for the provider default.
object
Optional typed filters for settled history metadata.
string
required
Environment ID whose settled history to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_ENVIRONMENT_PATCHESRetrieve a page of patches for a Railway environment, including identifiers and timestamps. The request accepts a page size and an after cursor, but the response does not return pagination information.

Input Parameters

string
Cursor for pagination - return patches after this cursor.
integer
Maximum number of patches to return (for pagination).
string
required
The unique identifier of the environment to get patches for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_ENVIRONMENT_PENDING_WORKList pending project-mutating work for a Railway environment, combining patches and standalone deploy operations. Returns parent operations with direct in-flight child metadata, statuses, timestamps, references, workflow IDs and actor metadata. Configuration changes and variable values are excluded at every level; deeper descendants are not expanded. Returns the full list without pagination. This live operation view is not a stored inbox or settled history. Does not apply, cancel or change pending work.

Input Parameters

string
required
Environment ID whose pending project-mutating operations to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_ENVIRONMENTSList one page of project environments with IDs, pull-request metadata, source environment, and staged-change count.

Input Parameters

integer
Maximum environments to return in this page.
string
required
Project ID whose environments to list.
string
Opaque cursor returned by the previous page; omit for the first page.
boolean
Filter ephemeral pull-request environments when set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_EXTERNAL_WORKSPACESGet the workspaces the user doesn’t belong to, but needs access (like when invited to a project)

Input Parameters

string
Railway project ID required by external workspaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_FUNCTION_RUNTIMESList available Railway function runtimes, including each runtime’s image, latest version and available version image tags. Returns the runtime catalog; does not create, deploy or modify a function. Accepts no arguments or pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_GIT_HUB_REPOSRetrieve a list of GitHub repositories that Railway has access to. Use this action when you need to fetch the list of GitHub repositories associated with the authenticated user’s GitHub account through Railway. This is a read-only operation that returns the id, name, and owner for each repository. The action queries the Railway GraphQL API githubRepos endpoint and returns the complete list of accessible GitHub repositories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_GIT_HUB_WRITABLE_SCOPESRetrieve the list of GitHub scopes the user has installed the installation to. Use this action when you need to fetch the list of GitHub scope names that the authenticated user has granted to the Railway GitHub application. This is a read-only operation that returns an array of GitHub permission scope strings such as ‘repo’, ‘workflow’, or ‘read:user’. Note: This endpoint requires account-level authentication, not workspace/project tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_HEROKU_APPSGet the Herokus apps for the current user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_INTEGRATION_AUTHSList Railway integration authorizations associated with the authenticated user. This read-only operation returns integration IDs, provider names and provider IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_INTEGRATIONSGet all integrations for a project

Input Parameters

integer
Maximum number of records to return from the corresponding side of integrations.
string
Pagination cursor used to continue integrations; obtain it from the previous page.
integer
Maximum number of records to return from the corresponding side of integrations.
string
Pagination cursor used to continue integrations; obtain it from the previous page.
string
required
Railway project ID required by integrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_MY_CLOUD_AGENTSFind cloud agents you own across every Railway project and environment you can access in one request. Optionally filter by archive state; omitted or null includes both archived and unarchived agents. Returns identifying metadata, last observed lifecycle state and public/private networking metadata, without session contents or credentials. Not paginated. Use List Cloud Agents to list an environment’s agents.

Input Parameters

boolean
True lists only archived agents; false only unarchived agents. Omit or pass null to include both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_NOTIFICATION_DELIVERIESRetrieve notification deliveries for the authenticated user, including their IDs, types, and creation timestamps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_NOTIFICATION_RULESGet all notification rules for a workspace and project

Input Parameters

string
Railway project ID required by notification rules.
string
required
Railway workspace ID required by notification rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_OBSERVABILITY_DASHBOARDSList one cursor-paginated page of Railway observability dashboards in an environment. Returns dashboard/item IDs, panel names, descriptions, types, selected metric/resource metadata and attached monitor identities/timestamps. Excludes layout blobs, free-form log filters, monitor configuration and alert content. Continue forward with pageInfo.endCursor as after or backward with pageInfo.startCursor as before, retaining environment_id. Does not run dashboard queries or modify dashboards.

Input Parameters

integer
Number of dashboards requested from the end of this page.
string
Forward pagination cursor from the preceding page’s endCursor.
integer
Number of dashboards requested from the start of this page.
string
Backward pagination cursor from the following page’s startCursor.
string
required
Environment ID whose observability dashboards to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_PRIVATE_NETWORKSList private networks for a Railway environment, including DNS name, network name, numeric and public identifiers, project/environment IDs, tags and nullable creation/deletion timestamps. Returns one unpaginated list. Does not create, modify, connect to or delete a private network.

Input Parameters

string
required
Environment ID whose private networks to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_PROJECT_EVENTSGet one page of Railway project events, optionally filtering by environment, action, object type or service ID. Returns event metadata and pageInfo for forward/backward cursor pagination. Does not return untyped event payloads or activity payloads, which may contain sensitive data. Read-only.

Input Parameters

integer
Backward page size; omit to use the provider’s default.
string
Return events after this opaque cursor.
integer
Forward page size; omit to use the provider’s default.
string
Return events before this opaque cursor.
object
Optional action, object type and service ID filters.
string
required
ID of the project whose events to list.
string
Optionally restrict events to this environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_PROJECT_FAVORITESThe authenticated user’s favorited project ids in a workspace, in the order the Favorites row should render them. Defaults to the order they were starred in.

Input Parameters

string ("CREATED_AT_DESC" | "NAME_ASC" | "UPDATED_AT_DESC")
Order by supplied to project favorites.
string
required
Railway workspace ID required by project favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_PROJECT_INVITATIONSGet invitations for a project

Input Parameters

string
required
Railway id ID required by project invitations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_PROJECT_MEMBERSList users belonging to a Railway project with their user IDs, email addresses, project roles, and available names and avatars. This read-only endpoint has no pagination. Does not invite users or change membership.

Input Parameters

string
required
ID of the project whose members to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_PROJECTSList one page of projects in an accessible Railway workspace with project and workspace identifiers. Use LIST_SERVICES and LIST_ENVIRONMENTS for those independently paginated resources.

Input Parameters

integer
Maximum projects to return in this page (1-100).
string
Opaque cursor returned by the previous page; omit for the first page.
string
required
Workspace ID whose accessible projects to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_RAILWAY_DOMAIN_DNS_RECORDSList DNS records for a Railway domain

Input Parameters

string
required
Domain supplied to railway domain dns records.
string
required
Railway workspace ID required by railway domain dns records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_RAILWAY_DOMAIN_EMAIL_FORWARDING_RULESList email forwarding rules for a Railway domain

Input Parameters

string
required
Domain supplied to railway domain email forwarding rules.
string
required
Railway workspace ID required by railway domain email forwarding rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_RAILWAY_DOMAINSGet Railway domains for a workspace

Input Parameters

string ("ACTIVE" | "EXPIRED" | "PURCHASING" | "REFUNDED")
Status supplied to railway domains.
string
required
Railway workspace ID required by railway domains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_REGIONSList available Railway regions, optionally passing a project ID. Returns country, location, identifiers and deployment constraints, including deprecation and replacement-region details when available. Returns a single list without pagination.

Input Parameters

string
Optional project ID to pass when listing available regions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_SANDBOX_CHECKPOINTSList named sandbox checkpoints in an environment.

Input Parameters

string
required
Railway environment ID required by sandbox checkpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_SANDBOXESList sandboxes in a Railway environment, newest first, with lifecycle state, region, idle timeout, network isolation and published domains. Filter by active or destroyed state. Without pagination arguments returns the full list; use first/after for forward pages or last/before for backward pages. Returns edge cursors and pageInfo for continuation.

Input Parameters

integer
Return the last N sandboxes for backward pagination.
string
Forward pagination cursor: pass pageInfo.endCursor from the previous response, with first.
integer
Return the first N sandboxes (newest first). Omit pagination arguments to return the full list.
boolean
True excludes destroyed sandboxes but includes failed and transitional states; false returns destroyed only. Omit for all states.
string
Backward pagination cursor: pass pageInfo.startCursor from the previous response, with last.
string
required
Environment ID whose sandboxes to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_SANDBOX_SESSIONSResumable sessions inside a sandbox — interactive shells and one-off exec commands, live or recently exited. Null when the sandbox can’t report them (e.g. its vm-init predates session listing).

Input Parameters

string
required
Railway id ID required by sandbox sessions.
integer
Maximum number of records to return from the corresponding side of sandbox sessions.
string
Pagination cursor used to continue sandbox sessions; obtain it from the previous page.
integer
Maximum number of records to return from the corresponding side of sandbox sessions.
string
Pagination cursor used to continue sandbox sessions; obtain it from the previous page.
string
required
Railway environment ID required by sandbox sessions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_SERVICESList one page of service IDs and names in a project for service, deployment, logs, metrics, domain, and volume tools.

Input Parameters

integer
Maximum services to return in this page (1-100).
string
required
Project ID whose services to list.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_SIGNALSList signals registered for an owner scope.

Input Parameters

string
Owner supplied to signals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_TCP_PROXIESList all Railway TCP proxies for a service in an environment, including public hostnames and ports, target application ports, synchronization states and available timestamps. Returns an empty list when no proxies exist. Does not create or modify network exposure. This endpoint has no pagination.

Input Parameters

string
required
ID of the service whose TCP proxies to list.
string
required
ID of the environment containing the service instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_TEMPLATESList one page of all published Railway templates, optionally restricted to recommended or verified templates. Uses query.templates, without a text search. Set first with after for forward pagination or last with before for backward pagination, retaining filters between calls. Returns summary metadata and native Relay cursors.

Input Parameters

integer
Maximum edges from the end of the selected range; use with before for backward pagination.
string
Return edges after this pageInfo.endCursor. Omit for the initial page.
integer
Maximum edges from the start of the selected range; use with after for forward pagination.
string
Return edges before this pageInfo.startCursor for backward pagination.
boolean
If true, return only verified templates. Omit to use Railway’s default.
If true, return only recommended templates. Omit to use Railway’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_TRACESList Railway environment traces with at least one span matching the filter, newest first. Optionally restrict by service and span-start time range; the default range is the last hour, clamped to project retention. Returns typed trace summaries, timing, error/span counts and root-service metadata, without raw span or resource attribute blobs. limit defaults to 100, maximum 500. This is a single bounded result list; the provider supplies no pagination cursor.

Input Parameters

integer
Maximum traces returned; Railway defaults to 100 and allows at most 500.
string
Span-filter expression, e.g. @status:error @component:edge @duration:>500 @http.route:/api/users. Built-ins: trace, span, name, serviceName, service, deployment, replica, component, kind, status, duration (ms). Other @keys match span/resource attributes; free text matches span names. Prefix a term with - to exclude it.
string
Latest span start to consider as an ISO timestamp; defaults to now.
string
Only traces with at least one span from this Railway service.
string
Oldest span start to consider as an ISO timestamp. Clamped to the project’s retention; defaults to one hour ago.
string
required
Environment ID whose traces to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_TRUSTED_DOMAINSFetch trusted domains configured for Railway workspace membership invitations, optionally specifying a workspace ID. The results can be used to audit domain configurations or obtain domain IDs.

Input Parameters

string
The workspace ID to retrieve trusted domains for. If not provided, uses the authenticated user’s workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_TRUSTED_DOMAINS_DIRECTGet all trusted domains for a workspace

Input Parameters

integer
Maximum number of records to return from the corresponding side of trusted domains.
string
Pagination cursor used to continue trusted domains; obtain it from the previous page.
integer
Maximum number of records to return from the corresponding side of trusted domains.
string
Pagination cursor used to continue trusted domains; obtain it from the previous page.
string
required
Railway workspace ID required by trusted domains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_VARIABLESReturn Railway shared-environment or service variables. Choose stored to preserve or render references, or deployment_resolved to return the values supplied to a specific service deployment. Variable values may be sensitive.

Input Parameters

string ("stored" | "deployment_resolved")
Return stored values or values resolved exactly as supplied to a service deployment.
string
required
Project ID containing the variables.
string
Service ID for service variables. Omit for shared environment variables. Required when view is deployment_resolved.
boolean
For the stored view, preserve Railway references such as ${{Service.KEY}} instead of rendering them. Ignored for deployment_resolved.
string
required
Environment ID containing the variables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_VOLUME_BACKUPSList backups of a Railway volume instance, returning backup IDs, names, creation and optional expiry timestamps, creator/schedule identifiers and available size metadata in MB. Use a volume instance ID, not the project-level volume ID. Returns the complete provider list without pagination; an empty list is valid. Reads only backup metadata, not backed-up contents. Does not create, restore or delete backups.

Input Parameters

string
required
Volume instance ID whose backups to list; not the project-level volume ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_VOLUME_BACKUP_SCHEDULESList backup schedules for a Railway volume instance, including names, IDs, frequency categories, cron expressions, creation times and optional retention durations in seconds. Returns schedules, not backup snapshots or database contents. Does not create, change or run a schedule.

Input Parameters

string
required
Volume instance ID whose backup schedules to list; not the parent volume ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_VOLUMESList one page of persistent volume IDs and names in a project for storage configuration and metrics workflows.

Input Parameters

integer
Maximum volumes to return in this page (1-100).
string
required
Project ID whose volumes to list.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_WORKSPACE_IDENTITY_PROVIDERSGets all identity providers of a workspace

Input Parameters

integer
Maximum number of records to return from the corresponding side of workspace identity providers.
string
Pagination cursor used to continue workspace identity providers; obtain it from the previous page.
integer
Maximum number of records to return from the corresponding side of workspace identity providers.
string
Pagination cursor used to continue workspace identity providers; obtain it from the previous page.
string
required
Railway workspace ID required by workspace identity providers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_WORKSPACE_POLICY_SELECTABLE_DEPLOY_SOURCESList deploy sources that can be added to a workspace policy.

Input Parameters

string
required
Source type supplied to workspace policy selectable deploy sources.
string
required
Railway workspace ID required by workspace policy selectable deploy sources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_LIST_WORKSPACE_TEMPLATESGet all templates for a workspace.

Input Parameters

integer
Maximum number of records to return from the corresponding side of workspace templates.
string
Pagination cursor used to continue workspace templates; obtain it from the previous page.
integer
Maximum number of records to return from the corresponding side of workspace templates.
string
Pagination cursor used to continue workspace templates; obtain it from the previous page.
string
required
Railway workspace ID required by workspace templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_MARK_NOTIFICATION_DELIVERIES_AS_READMarks notification deliveries as read

Input Parameters

array
required
Delivery ids supplied to notification deliveries mark as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_MERGE_CANVAS_VIEWMerge a canvas layout from one environment into another. Re-computes the merge from current state and applies mutations.

Input Parameters

string
required
Railway source environment ID required by canvas view merge.
string
required
Railway target environment ID required by canvas view merge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_PATCH_SERVICE_INSTANCE_VULN_REMEDIATION_NOWApply a pending database security update now (backup, then redeploy). Returns the new deployment id.

Input Parameters

string
required
Railway service ID required by service instance vuln remediation patch now.
string
required
Railway environment ID required by service instance vuln remediation patch now.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_PREVIEW_EGRESS_GATEWAY_HA_MIGRATIONPreview the HA static egress IPs that would be assigned, without applying them. Set allEnvironments to cover all of the service’s environments.

Input Parameters

object
required
Structured parameters for egress gateway ha migration preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_PREVIEW_HA_EGRESS_GATEWAYPreview the high-availability static egress IPv4 addresses that Railway would assign to a service in an environment, including region and optional availability zone. This read-only preview does not persist assignments or enable/configure static egress. Returns the provider’s full preview list without pagination.

Input Parameters

string
required
Service ID for which to preview HA static egress IP assignments.
string
required
Environment ID in which to preview HA static egress IPs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_PREVIEW_LEGACY_EGRESS_GATEWAYPreview the legacy static egress IPv4 addresses that Railway would assign to a service in an environment, including region and optional zone. This read does not persist an assignment, enable static outbound networking or reserve an IP.

Input Parameters

string
required
Service ID whose legacy static egress assignment to preview.
string
required
Environment ID containing the service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_PUBLISH_TEMPLATEPublish or update an existing Railway template in the public template marketplace, where other users can view and deploy it. Set category, description and README, optionally an image, demo project and workspace. A demo project becomes accessible through the public Live Demo link. Publishes the template’s existing configuration; ensure that configuration and supplied public text contain no secrets or raw environment-variable values. Returns metadata only, not template configuration.

Input Parameters

string
required
ID of the template to publish or update in the public marketplace.
string
Optional public template image URL or identifier.
string
required
Public template README content; do not include secrets or raw environment-variable values.
string
required
Marketplace category for the template.
string
required
Public marketplace description; do not include secrets or raw environment-variable values.
string
Optional workspace ID used to authorize template publication.
string
Optional demo project ID, exposed through the marketplace Live Demo link. Omit to leave provider default behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RECOVER_CLOUD_AGENT_TASKRecover the latest task response from the agent. May wake the VM.

Input Parameters

string
required
Railway session ID required by cloud agent task recover.
string
required
Railway cloud agent ID required by cloud agent task recover.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REDEPLOY_DEPLOYMENTCreate a new Railway deployment with the selected deployment’s exact code and build/deploy configuration, optionally using its previous image tag. This does not deploy the latest source commit and requires confirm=true.

Input Parameters

boolean
required
Must be true to confirm replacing the existing deployment state.
string
required
Deployment ID to redeploy.
boolean
Whether the redeployment should use the deployment’s previous image tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REDEPLOY_SERVICE_INSTANCERedeploy a service instance

Input Parameters

string
required
Railway service ID required by service instance redeploy.
string
required
Railway environment ID required by service instance redeploy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REMOVE_ACCESS_GROUP_MEMBERRemove a member from an access group. This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for access group member remove.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REMOVE_BOT_SCOPE_BINDINGRemove a Railway agent chat binding. Requires admin on the binding’s workspace. This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by bot scope binding remove.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REMOVE_FEATURE_FLAGRemove a feature flag for a user This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for feature flag remove.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REMOVE_PROJECT_FEATURE_FLAGRemove a feature flag for a project This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for project feature flag remove.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REMOVE_PROJECT_MEMBERRemove user from a project This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for project member remove.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REMOVE_RAILWAY_DOMAIN_EMAIL_FORWARDING_ALLStop forwarding every address on this domain, and remove the mail records that delivered them This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for railway domain email forwarding remove all.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REMOVE_SERVICE_FEATURE_FLAGRemove a feature flag for a service This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for service feature flag remove.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REMOVE_USER_FLAGSDeprecated by Railway: Use featureFlagRemove with PRIORITY_BOARDING. BETA leaves Priority Boarding. Remove a flag on the user. This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for user flags remove.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REMOVE_WORKSPACE_POLICY_DEPLOY_SOURCE_ALLOWLISTRemove a deploy source from a workspace policy allowlist. This is destructive and requires confirm=true.

Input Parameters

string
required
Railway id ID required by workspace policy deploy source allowlist remove.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REMOVE_WORKSPACE_USERRemove a user from a workspace This is destructive and requires confirm=true.

Input Parameters

object
required
Structured parameters for workspace user remove.
boolean
required
Must explicitly be true to confirm this destructive Railway action.
string
required
Railway workspace ID required by workspace user remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RENAME_CLOUD_AGENT_SESSIONSet a session’s title, shown over its generated one. An empty title clears it.

Input Parameters

string
required
Title supplied to cloud agent session rename.
string
required
The harness’s session id.
string
required
Railway cloud agent ID required by cloud agent session rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RENAME_ENVIRONMENTRename one environment without changing or deploying its configuration.

Input Parameters

string
required
New environment name.
string
required
Environment ID to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RENAME_PRIVATE_NETWORK_ENDPOINTRename a private network endpoint.

Input Parameters

string
required
Railway id ID required by private network endpoint rename.
string
required
Dns name supplied to private network endpoint rename.
string
required
Railway private network ID required by private network endpoint rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RENAME_SANDBOX_CHECKPOINTRename a sandbox checkpoint.

Input Parameters

string
required
Railway id ID required by sandbox checkpoint rename.
string
required
Name supplied to sandbox checkpoint rename.
string
required
Railway environment ID required by sandbox checkpoint rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REPLACE_SIGNALReplace a signal’s type and default, clearing all rules. Destructive — intended for CLI —force re-type.

Input Parameters

object
required
Structured parameters for signal replace.
boolean
required
Must explicitly be true to confirm this destructive Railway action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REPLACE_VARIABLESReplace the entire Railway shared-environment or service variable collection with the supplied complete map. This is irreversible: every existing variable whose key is omitted from the map is permanently deleted. Railway skips deployments by default; set skip_deploys=false and confirm_deploys=true to explicitly trigger deployments.

Input Parameters

object
required
Complete non-empty map of every variable that must remain in the target collection. Railway permanently deletes every existing key omitted here.
string
required
Project ID containing the target environment.
string
Service ID for service-specific variables. Omit this field to update shared environment variables.
boolean
Whether Railway should skip triggering deployments after the update. Defaults to true; setting false requires confirm_deploys=true.
string
required
Environment ID receiving the variables.
boolean
Set true to explicitly confirm triggering deployments when skip_deploys=false. This confirmation is not sent to Railway.
boolean
required
Must be true to confirm permanent deletion of every existing variable omitted from variables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REPORT_CLOUD_AGENT_STATEReport the current coding-agent session state.

Input Parameters

object
required
Structured parameters for cloud agent state report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RESEND_PROJECT_INVITATIONResend an invitation for a project

Input Parameters

string
required
Railway id ID required by project invitation resend.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RESET_OBSERVABILITY_DASHBOARDReset an observability dashboard to default dashboard items

Input Parameters

string
required
Railway id ID required by observability dashboard reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RESET_PLUGINDeprecated by Railway: Plugins are deprecated Reset envs and container for a plugin in an environment

Input Parameters

string
required
Railway id ID required by plugin reset.
object
required
Structured parameters for plugin reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RESPOND_CLOUD_AGENT_TASKAnswer a question the task is waiting on. Wakes a sleeping VM to deliver it (the question survives sleep); poll cloudAgentTask for the outcome.

Input Parameters

object
required
Structured parameters for cloud agent task respond.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RESTAGE_ENVIRONMENT_PATCHCopy a FAILED patch’s changes into the environment’s staged patch (creating one if needed). The FAILED patch is left untouched.

Input Parameters

string
required
Railway patch ID required by environment patch restage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RESTART_DEPLOYMENTRestart a running or crashed Railway deployment by reusing its existing image without rebuilding or creating a deployment from newer source. Requires confirm=true.

Input Parameters

boolean
required
Must be true to confirm interrupting and restarting the deployment.
string
required
Deployment ID to restart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RESTART_PLUGINDeprecated by Railway: Plugins are deprecated Restarts a plugin.

Input Parameters

string
required
Railway id ID required by plugin restart.
object
required
Structured parameters for plugin restart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RESTORE_VOLUME_BACKUPStart restoring a Railway volume instance from a backup. This overwrites target volume data. Optionally restore HA replica services and wipe specified services’ volumes to fresh empty volumes. Returns asynchronous workflow metadata, not proof that restoration has finished.

Input Parameters

array
Service IDs whose volumes should be wiped and replaced with fresh empty volumes as part of this restore. This destroys their current contents.
string
required
ID of the target volume instance to restore.
array
For HA cluster restores, service IDs of replicas that should also receive the backup.
string
required
ID of the volume instance backup to restore from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RESTORE_VOLUME_POINT_IN_TIMEStart a point-in-time restore from a PostgreSQL or MySQL database volume instance’s PITR backup history. Creates and deploys a brand-new sibling database service and volume in the project; the source stays online and untouched. The new service inherits source environment configuration and recovery references. Requires an existing base backup and archived logs covering the target. Returns nullable workflow metadata, not restored data or completion status; cutover is separate.

Input Parameters

string
Optional restored service name; defaults to ‘<source>-restored-YYYYMMDD-HHMM’.
string
Backup history identifier from the source’s backup history picker; null uses its current history.
string
required
ISO 8601 point-in-time target within the source’s available PITR restore window.
string
required
Source database volume instance ID, not the parent volume ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RETRIGGER_TRUSTED_DOMAIN_VERIFICATIONRetrigger verification for a failed trusted domain

Input Parameters

string
required
Railway id ID required by trusted domain retrigger verification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_RETRY_DOMAIN_CERTIFICATERead the corrected Railway domainStatus object, then retry custom-domain certificate issuance only when Railway reports certificateRetryable=true. A non-retryable result fails without mutation and includes status evidence.

Input Parameters

string
required
Custom-domain ID whose certificate issuance should be retried.
string
required
Project ID containing the custom domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_REVERT_TEMPLATEReverts an HA cluster to standalone mode using template metadata to derive variables to remove

Input Parameters

object
required
Structured parameters for template revert.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ROLLBACK_DEPLOYMENTRestore a previous Railway deployment’s Docker image and custom variables as the active deployment without rebuilding. Railway must report canRollback=true; the operation requires confirm=true.

Input Parameters

boolean
required
Must be true to confirm rolling back the deployment.
string
required
Deployment ID to roll back.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_ROLLBACK_SIGNALRestore a signal to the snapshot captured before a change (reads prevState from the target change row).

Input Parameters

object
required
Structured parameters for signal rollback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SEARCH_TEMPLATESSearch one cursor-controlled page of Railway templates by text, verification state, and category.

Input Parameters

integer
Maximum templates to return in this page.
string
required
Template search text.
string
Template category to restrict results to when set.
boolean
Restrict results to verified or unverified templates when set.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SEND_RAILWAY_DOMAIN_EMAIL_FORWARDING_RULE_TESTSend a message to a forwarded address so the customer can confirm it delivers.

Input Parameters

object
required
Structured parameters for railway domain email forwarding rule send test.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SEND_SANDBOX_HEARTBEATExtend a sandbox’s lifetime.

Input Parameters

string
required
Railway id ID required by sandbox heartbeat.
string
required
Railway environment ID required by sandbox heartbeat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SET_DEV_NEW_LANDING_TARGETMake this cloud agent the box ssh dev.new lands you in. Replaces any previous choice.

Input Parameters

string
required
Railway cloud agent ID required by dev new landing target set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SET_PROJECT_FAVORITEStar or unstar a project for the authenticated user. Returns the resulting state.

Input Parameters

boolean
required
Favorite supplied to project favorite set.
string
required
Railway project ID required by project favorite set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SET_RAILWAY_DOMAIN_NAMESERVERSDelegate the domain’s authoritative nameservers to an external DNS provider, or reset to Railway defaults by passing an empty list.

Input Parameters

object
required
Structured parameters for railway domain nameservers set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SET_SERVICE_UNDER_ATTACK_MODEEnables or disables Under Attack Mode for a service. While enabled, the edge serves a browser challenge to unverified visitors of the service’s edge-routed domains; non-browser clients (APIs, webhooks) without a clearance cookie are rejected with a 429. Optionally time-boxed via durationSeconds, after which the mode disarms automatically.

Input Parameters

object
required
Structured parameters for set service under attack mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SET_SIGNAL_DEFAULTChange a signal’s canonical default (production floor).

Input Parameters

object
required
Structured parameters for signal default set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SET_SIGNAL_RULEAttach or replace a rule on a signal. Matching rules must agree at resolution time or the default is returned.

Input Parameters

object
required
Structured parameters for signal rule set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SET_USER_FLAGSDeprecated by Railway: Use featureFlagAdd with PRIORITY_BOARDING. BETA joins Priority Boarding. Set flags on the authenticated user.

Input Parameters

object
required
Structured parameters for user flags set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SLEEP_CLOUD_AGENTSleep a running cloud agent, keeping its volume. Processes on the machine are terminated; waking re-runs its entrypoint.

Input Parameters

string
required
Railway id ID required by cloud agent sleep.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_SNOOZE_SERVICE_INSTANCE_AUTO_UPDATESkip the next scheduled auto-update for a service instance. Takes effect immediately, with no staged change and no redeploy. The maintenance window and update policy stay as they are. This only delays the next scheduled update.

Input Parameters

string
required
Railway service ID required by service instance auto update snooze.
integer
How many days to skip, from now (default 7 — covers any weekly schedule shape). Between 1 and 14.
string
required
Railway environment ID required by service instance auto update snooze.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_STAGE_TEMPLATECreate all resources from a complete Railway template configuration in a new project or an existing project environment, but leave the resulting changes staged. This does not commit the staged changes or start deployments; commit them separately when ready.

Input Parameters

string
Existing target project ID. Requires environment_id.
string
required
Template ID returned by GET_TEMPLATE.
string
Workspace ID in which Railway should create a new project. It may also be supplied with an existing project target.
string
Existing target environment ID. Requires project_id.
object
required
Complete serialized template configuration returned by GET_TEMPLATE, optionally customized while preserving its required structure.
string
Existing service to use as the template cluster root. Provide this only with both project_id and environment_id; it cannot be used with a workspace-only target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_START_PLUGINDeprecated by Railway: Plugins are deprecated Force start a plugin

Input Parameters

string
required
Railway id ID required by plugin start.
object
required
Structured parameters for plugin start.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_STOP_DEPLOYMENTStop a currently running Railway deployment without deleting the service or its deployment-history record. Requires confirm=true.

Input Parameters

boolean
required
Must be true to confirm stopping the deployment.
string
required
Deployment ID to stop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_TRANSFER_ENVIRONMENT_IAC_PARTIALTransfer resources between named IaC partials without deleting, redeploying, or changing them. Omit resources to transfer the entire source partial. The destination may be a new or existing partial.

Input Parameters

array
Resource addresses to transfer (for example service.api). Every address must belong to fromPartial. Omit to transfer all of its resources; an empty list is rejected.
string
required
To partial supplied to environment iac partial transfer.
string
required
From partial supplied to environment iac partial transfer.
string
required
Railway environment ID required by environment iac partial transfer.
string
Snapshot token from Environment.configEtag the ownership preview was computed against. When set, the transfer is rejected if the environment has changed since.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_TRANSFER_PROJECTTransfer a project to a workspace

Input Parameters

object
required
Structured parameters for project transfer.
string
required
Railway project ID required by project transfer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UNARCHIVE_CLOUD_AGENTBring an archived cloud agent back. Owner only.

Input Parameters

string
required
Railway id ID required by cloud agent unarchive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UNPUBLISH_TEMPLATEUnpublish a Railway template by ID. Requires permission to manage the template. Returns Railway’s Boolean acknowledgement as unpublished; a false value does not confirm unpublishing. Does not delete the template.

Input Parameters

string
required
ID of the Railway template to unpublish.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_ACCESS_GROUPUpdate an access group’s name or role.

Input Parameters

string
required
Railway id ID required by access group update.
object
required
Structured parameters for access group update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_BASE_ENVIRONMENT_OVERRIDESets the base environment override for a deployment trigger.

Input Parameters

string
required
Railway id ID required by base environment override.
object
required
Structured parameters for base environment override.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_BUCKETRename an existing Railway bucket by ID and return its bucket metadata. This updates the display name without changing environment configuration.

Input Parameters

string
required
ID of the Railway bucket to rename.
object
required
Bucket metadata changes to apply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_CLOUD_AGENT_MARK_SEENRecord that the agent’s owner looked, so its DONE and ERROR outcomes stop being unseen. Without sessionId, every session. Owner only.

Input Parameters

string
The harness’s session id.
string
required
Railway cloud agent ID required by cloud agent mark seen.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_CLOUD_AGENT_TASK_DISPATCHStart a task and return its handle. Creates a fresh agent by default; replyToTaskId continues the original conversation.

Input Parameters

object
required
Structured parameters for cloud agent task dispatch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_DEPLOYMENT_TRIGGERUpdates a deployment trigger.

Input Parameters

string
required
Railway id ID required by deployment trigger update.
object
required
Structured parameters for deployment trigger update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_DOMAINUpdate a generated Railway domain’s hostname and optionally its target port, or update a custom domain’s target port. Generated-domain updates require the service ID and hostname.

Input Parameters

string
Generated railway.app hostname. Required for generated Railway domains and invalid for custom domains.
string
required
Service-domain or custom-domain ID to update.
string
Service ID. Required for generated Railway domains and invalid for custom domains.
string ("railway" | "custom")
required
Kind of domain being updated.
integer
New service target port. Required for custom domains and optional for generated Railway domains.
string
required
Environment ID containing the domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_EGRESS_GATEWAY_ROLLBACK_FROM_HASwitch a service from HA static egress IPs back to a standard static IP. Set allEnvironments to apply to all of the service’s environments.

Input Parameters

object
required
Structured parameters for egress gateway rollback from ha.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_ENVIRONMENT_CLEARANCE_DEFAULTSets whether Railway Authentication protects an environment’s services that have no setting of their own, and pushes it to them. Requires a workspace admin; turning it on also requires the workspace’s Railway Authentication entitlement. Services with edge caching on that it protects have their caching turned off.

Input Parameters

object
required
Structured parameters for environment clearance default update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_ENVIRONMENT_IAC_PARTIAL_RELEASERelease resources from a named IaC partial without deleting, redeploying, or changing them. Omit resources to release the entire partial. Whole-project management is possible once no named partials remain. A later named-partial apply can claim released resources again.

Input Parameters

string
required
Partial supplied to environment iac partial release.
array
Resource addresses to release (for example service.api). Every address must belong to the named partial. Omit to release all of its resources; an empty list is rejected.
string
required
Railway environment ID required by environment iac partial release.
string
Snapshot token from Environment.configEtag the ownership preview was computed against. When set, the release is rejected if the environment has changed since.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_ENVIRONMENT_UNSKIP_SERVICEDeploy a service that was skipped when its environment was created, along with its skipped transitive dependencies.

Input Parameters

string
required
Railway service ID required by environment unskip service.
string
required
Railway environment ID required by environment unskip service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_FAIR_USE_AGREEAgree to the fair use policy for the currently authenticated user

Input Parameters

boolean
required
Agree supplied to fair use agree.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_GITHUB_REPOUpdates a GitHub repo through the linked template

Input Parameters

object
required
Structured parameters for github repo update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_INTEGRATIONUpdate an integration for a project

Input Parameters

string
required
Railway id ID required by integration update.
object
required
Structured parameters for integration update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_NOTIFICATION_RULEUpdate a notification rule

Input Parameters

string
required
Railway id ID required by notification rule update.
object
required
Structured parameters for notification rule update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_OBSERVABILITY_DASHBOARDUpdate an observability dashboard

Input Parameters

string
required
Railway id ID required by observability dashboard update.
array
required
Structured parameters for observability dashboard update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_PLUGINDeprecated by Railway: Plugins are deprecated Updates an existing plugin.

Input Parameters

string
required
Railway id ID required by plugin update.
object
required
Structured parameters for plugin update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_PREFERENCESUpdate the email preferences for a user

Input Parameters

object
required
Structured parameters for preferences update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_PROJECTUpdate project settings and configuration on Railway. Use this action when you need to modify project properties such as description, visibility settings, or PR deploy preferences. The following fields can be updated: - description: A brief description of the project - isPublic: Whether the project is publicly visible - prDeploys: Whether pull request preview deployments are enabled This is an idempotent operation — updating a project with the same settings multiple times will not change the result after the first update.

Input Parameters

string
required
The unique identifier of the project to update.
object
required
The update configuration for the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_PROJECT_CLEARANCE_DEFAULTSets whether environments created from now on start with Railway Authentication protecting services that have no setting of their own. Existing environments are unchanged. Requires a workspace admin; turning it on also requires the workspace’s Railway Authentication entitlement.

Input Parameters

object
required
Structured parameters for project clearance default update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_PROJECT_MEMBERChange the role for a user within a project

Input Parameters

object
required
Structured parameters for project member update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_PROJECT_TRANSFER_TO_TEAMDeprecated by Railway: Use projectTransfer instead Transfer a project to a team

Input Parameters

string
required
Railway id ID required by project transfer to team.
object
required
Structured parameters for project transfer to team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_PURGE_SERVICE_CACHEPurges the CDN cache for a service. Bumps the edge config’s purge epoch so every edge node treats prior cached entries as stale on next request. Idempotent; returns true even if CDN is disabled for the service.

Input Parameters

object
required
Structured parameters for purge service cache.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_RAILWAY_DOMAINUpdate a Railway domain’s settings

Input Parameters

object
required
Structured parameters for railway domain update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_RAILWAY_DOMAIN_DNS_RECORDUpdate a DNS record for a Railway domain

Input Parameters

object
required
Structured parameters for railway domain dns record update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_RAILWAY_DOMAIN_EMAIL_FORWARDING_RULEChange where a forwarded address delivers

Input Parameters

object
required
Structured parameters for railway domain email forwarding rule update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_REFERRAL_INFOUpdates the ReferralInfo for the authenticated user.

Input Parameters

object
required
Structured parameters for referral info update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SERVICEUpdate a service’s name or icon without changing environment-specific deployment settings.

Input Parameters

string
New service icon value. Provide name, icon, or both.
string
New service name. Provide name, icon, or both.
string
required
Service ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SERVICE_EDGE_CONFIGUpdates the edge config (caching settings) for a service.

Input Parameters

object
required
Structured parameters for update service edge config.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SERVICE_EDGE_RULESReplaces the service’s edge rules (whole-section replace; null clears). Rules are boolean expressions over request attributes plus one action (block/allow/challenge/redirect/cache_override), evaluated at the edge before requests reach the service. The ruleset is validated server-side; invalid rulesets are rejected with per-rule diagnostics and nothing is written. Rules without an id get a server-assigned stable rul_ id.

Input Parameters

object
required
Structured parameters for update service edge rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SERVICE_INSTANCEUpdate build/deploy settings for a service in a specific environment on Railway. Use this action when you need to modify service configuration including commands, healthcheck, replicas, region, and cron schedule. This is an idempotent operation. The following fields can be updated: - startCommand: Custom start command for the service - buildCommand: Custom build command - rootDirectory: Root directory for monorepo setups - healthcheckPath: Health check endpoint path - healthcheckTimeout: Health check timeout in seconds - region: Deployment region - numReplicas: Number of service replicas - restartPolicyType: Restart policy (ON_FAILURE, ALWAYS, NEVER) - restartPolicyMaxRetries: Maximum restart retries - cronSchedule: Cron expression for scheduled deployments - sleepApplication: Enable/disable sleep when idle - dockerfilePath: Custom Dockerfile path - watchPatterns: File patterns for automatic redeployment

Input Parameters

object
required
The update configuration for the service instance.
string
required
The unique identifier of the service to update.
string
required
The unique identifier of the environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SERVICE_INSTANCE_AUTO_DEPLOYEnables or disables auto-deploy for a service instance.

Input Parameters

object
required
Structured parameters for service instance auto deploy update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SERVICE_INSTANCE_AUTO_UPDATE_SCHEDULEUpdate the auto-update maintenance window for a service instance, applied immediately (no config staging, no redeploy). Only the schedule changes — the update policy is untouched.

Input Parameters

array
required
The full replacement set of weekly UTC maintenance windows (at least one)
string
required
Railway service ID required by service instance auto update schedule update.
string
required
Railway environment ID required by service instance auto update schedule update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SERVICE_INSTANCE_CLEARANCESets a service instance’s own Railway Authentication setting: on, off, or none (follow the environment’s default). Requires a workspace admin; ending up on also requires the workspace’s Railway Authentication entitlement and edge caching off.

Input Parameters

object
required
Structured parameters for service instance clearance update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SERVICE_INSTANCE_LIMITSUpdate the resource limits for a service instance

Input Parameters

object
required
Structured parameters for service instance limits update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SERVICE_REMOVE_UPSTREAM_URLRemove the upstream URL from all service instances for this service

Input Parameters

string
required
Railway id ID required by service remove upstream url.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SHARED_VARIABLE_CONFIGUREConfigure a shared variable.

Input Parameters

object
required
Structured parameters for shared variable configure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_SIGNAL_RULE_UNSETRemove a rule from a signal.

Input Parameters

object
required
Structured parameters for signal rule unset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_TEMPLATE_VOLUMESets the default size (in MB) for a volume mount in a template’s config. New volumes created when the template is deployed are provisioned at this size, clamped to the deployer’s plan maximum. Pass sizeMB: null to clear the pre-size and fall back to the plan default. Editing a template requires maintainer access.

Input Parameters

integer
Size mb supplied to template volume update.
string
required
Railway volume ID required by template volume update.
string
required
Railway service ID required by template volume update.
string
required
Railway template ID required by template volume update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_TRUSTED_DOMAINUpdate the role of a trusted domain

Input Parameters

object
required
Structured parameters for trusted domain update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_USER_PROFILEUpdates the profile for the authenticated user

Input Parameters

object
required
Structured parameters for user profile update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_USER_TERMSUpdate date of TermsAgreedOn

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_VOLUMERename a Railway volume without changing any volume instance.

Input Parameters

string
required
New volume name.
string
required
Volume ID to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_VOLUME_INSTANCEUpdate a Railway volume’s environment-specific mount path, attached service, or state. service_id is required on every call as the current or target attachment; set it to null only to explicitly keep or make the instance disconnected.

Input Parameters

string ("ERROR" | "MIGRATING" | "MIGRATION_PENDING" | "READY" | "RESTORING" | "UPDATING")
New non-deletion Railway volume-instance state: ERROR, MIGRATING, MIGRATION_PENDING, READY, RESTORING, or UPDATING. Omit to preserve the current state. Use DELETE_VOLUME for irreversible volume deletion.
string
required
Volume ID to configure.
string
New absolute mount path. Omit to preserve the current mount path; service_id is still required to preserve or change the attachment.
string
required
Current or target attached service ID. This field is always required and must be null only to explicitly keep or make the instance disconnected; Railway disconnects the volume instance when serviceId is omitted.
string
required
Environment ID containing the volume instance to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_VOLUME_INSTANCE_BACKUP_LOCKRemoves backup expiration date

Input Parameters

string
required
The id of the volume instance to be restored from
string
required
The id of the backup to lock

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_VOLUME_INSTANCE_BACKUP_SCHEDULEManage schedule for backups of a volume instance

Input Parameters

array
required
The frequency/retention of the backups
string
required
The id of the volume instance to create a backup of

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_WORKSPACEUpdate a Railway workspace’s name, avatar, or preferred region. Omitted fields stay unchanged; explicit null values are sent to Railway. Requires admin access to the workspace.

Input Parameters

string
New workspace name. Omit to leave unchanged.
string
Workspace avatar URL. Omit to leave unchanged.
string
required
ID of the workspace to update.
string
Preferred region for the workspace. Omit to leave unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_WORKSPACE_PERMISSION_CHANGEChanges a user workspace permissions.

Input Parameters

object
required
Structured parameters for workspace permission change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_WORKSPACE_POLICY_ITEMEnable or disable a workspace policy. Enterprise workspaces only.

Input Parameters

object
Structured parameters for workspace policy item update.
string ("RESTRICT_DEPLOYS_TO_ALLOWED_SOURCES" | "RESTRICT_PUBLIC_TCP_PROXIES" | "RESTRICT_RAILWAY_DOMAIN_GENERATION")
Policy supplied to workspace policy item update.
boolean
Enabled supplied to workspace policy item update.
string
required
Railway workspace ID required by workspace policy item update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPDATE_WORKSPACE_SET_RESTRICT_PROJECT_VISIBILITY_TO_GROUPSControl whether non-admin project visibility is restricted to access groups and direct project permissions.

Input Parameters

boolean
required
Enabled supplied to workspace set restrict project visibility to groups.
string
required
Railway workspace ID required by workspace set restrict project visibility to groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPGRADE_EGRESS_GATEWAY_TO_HAEnable HA static egress IPs for a service. Set allEnvironments to apply to all of the service’s environments.

Input Parameters

object
required
Structured parameters for egress gateway upgrade to ha.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPSERT_SLACK_CHANNEL_BY_WORKSPACE_IDCreate or return a workspace Slack channel through Railway’s upsertSlackChannel route, which identifies the workspace with workspace_id.

Input Parameters

string
required
Railway workspace ID required by upsert slack channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPSERT_VARIABLESCreate or update a non-empty map of Railway shared-environment or service variables without deleting variables omitted from the submitted map. Railway skips deployments by default. Set skip_deploys=false and confirm_deploys=true to explicitly trigger deployments.

Input Parameters

object
required
Non-empty map of variable names to string values.
string
required
Project ID containing the target environment.
string
Service ID for service-specific variables. Omit this field to update shared environment variables.
boolean
Whether Railway should skip triggering deployments after the update. Defaults to true; setting false requires confirm_deploys=true.
string
required
Environment ID receiving the variables.
boolean
Set true to explicitly confirm triggering deployments when skip_deploys=false. This confirmation is not sent to Railway.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_UPSERT_WORKSPACE_SLACK_CHANNEL_BY_IDCreate or return a workspace Slack channel through Railway’s workspaceUpsertSlackChannel route, which identifies the workspace with id.

Input Parameters

string
required
Railway id ID required by workspace upsert slack channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_VALIDATE_SERVICE_EDGE_RULESValidates an edge ruleset without writing it — returns the same diagnostics updateServiceEdgeRules would reject with (empty list = valid). For live feedback in rule editors.

Input Parameters

object
required
Structured parameters for validate service edge rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAILWAY_WAKE_CLOUD_AGENTWake a sleeping cloud agent.

Input Parameters

string
required
Railway id ID required by cloud agent wake.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not