cloud_agent_console_sessions

Creates, updates, deletes, gets or lists a cloud_agent_console_sessions resource.

Overview

Name	cloud_agent_console_sessions
Type	Resource
Id	railway.agents.cloud_agent_console_sessions

Fields

The following fields are returned by SELECT queries:

list

One row per SandboxSession. A resumable session inside a sandbox: an interactive shell or a one-off exec command.

Name	Datatype	Description
name	string	Stable session name; reconnect/attach by this.
attached	boolean	Whether a client is currently connected.
command	string	The command being run; empty for an interactive shell.
created_at	string (date-time)
foreground_active	boolean	For an interactive shell, whether a foreground program currently holds the terminal. Null otherwise, or when the runtime can't report it.
kind	string	(EXEC, SHELL)
run_state	object	SandboxSessionRunState object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	cloud_agent_id		Shell and exec sessions running on a cloud agent's VM that you can reconnect to. Null if the agent has no running machine. Backed by the Railway GraphQL query cloudAgentConsoleSessions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cloud_agent_id	string

SELECT examples

list

Shell and exec sessions running on a cloud agent's VM that you can reconnect to. Null if the agent has no running machine. Backed by the Railway GraphQL query cloudAgentConsoleSessions.

SELECT
name,
attached,
command,
created_at,
foreground_active,
kind,
run_state
FROM railway.agents.cloud_agent_console_sessions
WHERE cloud_agent_id = '{{ cloud_agent_id }}' -- required
;