tcp_proxies

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

Overview

Name	tcp_proxies
Type	Resource
Id	railway.networking.tcp_proxies

Fields

The following fields are returned by SELECT queries:

list

One row per TCPProxy.

Name	Datatype	Description
id	string
environment_id	string
service_id	string
application_port	integer
created_at	string (date-time)
deleted_at	string (date-time)
domain	string
proxy_port	integer
sync_status	string	(ACTIVE, CREATING, DELETED, DELETING, UNSPECIFIED, UPDATING)
updated_at	string (date-time)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	environment_id, service_id		All TCP proxies for a service instance. Backed by the Railway GraphQL query tcpProxies.
delete	delete	id		Deletes a TCP proxy by id. Backed by the Railway GraphQL mutation tcpProxyDelete.

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
environment_id	string
service_id	string
id	string

SELECT examples

list

All TCP proxies for a service instance. Backed by the Railway GraphQL query tcpProxies.

SELECT
id,
environment_id,
service_id,
application_port,
created_at,
deleted_at,
domain,
proxy_port,
sync_status,
updated_at
FROM railway.networking.tcp_proxies
WHERE environment_id = '{{ environment_id }}' -- required
AND service_id = '{{ service_id }}' -- required
;

DELETE examples

delete

Deletes a TCP proxy by id. Backed by the Railway GraphQL mutation tcpProxyDelete.

DELETE FROM railway.networking.tcp_proxies
WHERE 
id = '{{ id }}' --required
;