private_network_endpoints

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

Overview

Name	private_network_endpoints
Type	Resource
Id	railway.networking.private_network_endpoints

Fields

The following fields are returned by SELECT queries:

get

One PrivateNetworkEndpoint row.

Name	Datatype	Description
public_id	string
service_instance_id	string
dns_name	string
new_dns_name	string
created_at	string (date-time)
deleted_at	string (date-time)
private_ips	array
sync_status	string	(ACTIVE, CREATING, DELETED, DELETING, UNSPECIFIED, UPDATING)
tags	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	environment_id, private_network_id, service_id		Get a private network endpoint for a service instance. Backed by the Railway GraphQL query privateNetworkEndpoint.
rename	update	dns_name, id, private_network_id		Rename a private network endpoint. Backed by the Railway GraphQL mutation privateNetworkEndpointRename.

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
private_network_id	string
service_id	string
dns_name	string
id	string

SELECT examples

get

Get a private network endpoint for a service instance. Backed by the Railway GraphQL query privateNetworkEndpoint.

SELECT
public_id,
service_instance_id,
dns_name,
new_dns_name,
created_at,
deleted_at,
private_ips,
sync_status,
tags
FROM railway.networking.private_network_endpoints
WHERE environment_id = '{{ environment_id }}' -- required
AND private_network_id = '{{ private_network_id }}' -- required
AND service_id = '{{ service_id }}' -- required
;

UPDATE examples

rename

Rename a private network endpoint. Backed by the Railway GraphQL mutation privateNetworkEndpointRename.

UPDATE railway.networking.private_network_endpoints
SET 

WHERE 
dns_name = '{{ dns_name }}' --required
AND id = '{{ id }}' --required
AND private_network_id = '{{ private_network_id }}' --required
RETURNING
result;