workspace_policies

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

Overview

Name	workspace_policies
Type	Resource
Id	railway.workspaces.workspace_policies

Fields

The following fields are returned by SELECT queries:

get

One WorkspacePolicy row.

Name	Datatype	Description
id	string
restrict_deploys_to_allowed_sources	boolean
restrict_public_tcp_proxies	boolean
restrict_railway_domain_generation	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workspace_id		Get the policies for a workspace. Backed by the Railway GraphQL query workspacePolicy.
update	update	input_enabled, input_policy, workspace_id		Enable or disable a workspace policy. Enterprise workspaces only. Backed by the Railway GraphQL mutation workspacePolicyItemUpdate.

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
workspace_id	string
input_enabled	boolean
input_policy	string	(RESTRICT_DEPLOYS_TO_ALLOWED_SOURCES, RESTRICT_PUBLIC_TCP_PROXIES, RESTRICT_RAILWAY_DOMAIN_GENERATION)

SELECT examples

get

Get the policies for a workspace. Backed by the Railway GraphQL query workspacePolicy.

SELECT
id,
restrict_deploys_to_allowed_sources,
restrict_public_tcp_proxies,
restrict_railway_domain_generation
FROM railway.workspaces.workspace_policies
WHERE workspace_id = '{{ workspace_id }}' -- required
;

UPDATE examples

update

Enable or disable a workspace policy. Enterprise workspaces only. Backed by the Railway GraphQL mutation workspacePolicyItemUpdate.

UPDATE railway.workspaces.workspace_policies
SET 
enabled = '{{ enabled }}',
policy = '{{ policy }}'
WHERE 
input_enabled = '{{ input_enabled }}' --required
AND input_policy = '{{ input_policy }}' --required
AND workspace_id = '{{ workspace_id }}' --required
RETURNING
result;