railway_domains

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

Overview

Name	railway_domains
Type	Resource
Id	railway.networking.railway_domains

Fields

The following fields are returned by SELECT queries:

get_by_name

One RailwayDomain row.

Name	Datatype	Description
id	string
workspace_id	string
workspace_name	string
auto_renew_enabled	boolean
connected_service_instances	array	List of ConnectedServiceInstance objects
created_at	string (date-time)
domain	string
nameservers	object	Authoritative nameservers currently delegated for this domain at the registrar.
next_billing_date	string (date-time)
purchase_price	integer
registration_years	integer
renewal_price	integer
status	string	(ACTIVE, EXPIRED, PURCHASING, REFUNDED)

get

One RailwayDomain row.

Name	Datatype	Description
id	string
workspace_id	string
workspace_name	string
auto_renew_enabled	boolean
connected_service_instances	array	List of ConnectedServiceInstance objects
created_at	string (date-time)
domain	string
nameservers	object	Authoritative nameservers currently delegated for this domain at the registrar.
next_billing_date	string (date-time)
purchase_price	integer
registration_years	integer
renewal_price	integer
status	string	(ACTIVE, EXPIRED, PURCHASING, REFUNDED)

list

One row per RailwayDomain.

Name	Datatype	Description
id	string
workspace_id	string
workspace_name	string
auto_renew_enabled	boolean
connected_service_instances	array	List of ConnectedServiceInstance objects
created_at	string (date-time)
domain	string
nameservers	object	Authoritative nameservers currently delegated for this domain at the registrar.
next_billing_date	string (date-time)
purchase_price	integer
registration_years	integer
renewal_price	integer
status	string	(ACTIVE, EXPIRED, PURCHASING, REFUNDED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_name	select	domain, workspace_id		Get a Railway domain by its domain name within a workspace. Backed by the Railway GraphQL query railwayDomainByName.
get	select	id		Get a Railway domain by ID. Backed by the Railway GraphQL query railwayDomain.
list	select	workspace_id	status	Get Railway domains for a workspace. Backed by the Railway GraphQL query railwayDomains.
update	update	id		Update a Railway domain's settings. Backed by the Railway GraphQL mutation railwayDomainUpdate.
set_nameservers	exec	id, nameservers		Delegate the domain's authoritative nameservers to an external DNS provider, or reset to Railway defaults by passing an empty list. Backed by the Railway GraphQL mutation railwayDomainNameserversSet.

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
domain	string
id	string
workspace_id	string
status	string
nameservers	array	Hostnames of the nameservers to delegate to (2-13). Pass an empty list to reset to Name.com's account-level defaults for this domain.

SELECT examples

get_by_name

Get a Railway domain by its domain name within a workspace. Backed by the Railway GraphQL query railwayDomainByName.

SELECT
id,
workspace_id,
workspace_name,
auto_renew_enabled,
connected_service_instances,
created_at,
domain,
nameservers,
next_billing_date,
purchase_price,
registration_years,
renewal_price,
status
FROM railway.networking.railway_domains
WHERE domain = '{{ domain }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
;

get

Get a Railway domain by ID. Backed by the Railway GraphQL query railwayDomain.

SELECT
id,
workspace_id,
workspace_name,
auto_renew_enabled,
connected_service_instances,
created_at,
domain,
nameservers,
next_billing_date,
purchase_price,
registration_years,
renewal_price,
status
FROM railway.networking.railway_domains
WHERE id = '{{ id }}' -- required
;

list

Get Railway domains for a workspace. Backed by the Railway GraphQL query railwayDomains.

SELECT
id,
workspace_id,
workspace_name,
auto_renew_enabled,
connected_service_instances,
created_at,
domain,
nameservers,
next_billing_date,
purchase_price,
registration_years,
renewal_price,
status
FROM railway.networking.railway_domains
WHERE workspace_id = '{{ workspace_id }}' -- required
AND status = '{{ status }}'
;

UPDATE examples

update

Update a Railway domain's settings. Backed by the Railway GraphQL mutation railwayDomainUpdate.

UPDATE railway.networking.railway_domains
SET 
auto_renew_enabled = '{{ auto_renew_enabled }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
workspace_id,
workspace_name,
auto_renew_enabled,
connected_service_instances,
created_at,
domain,
nameservers,
next_billing_date,
purchase_price,
registration_years,
renewal_price,
status;

Lifecycle Methods

set_nameservers

Delegate the domain's authoritative nameservers to an external DNS provider, or reset to Railway defaults by passing an empty list. Backed by the Railway GraphQL mutation railwayDomainNameserversSet.

EXEC railway.networking.railway_domains.set_nameservers 
@id='{{ id }}', --required
@nameservers='{{ nameservers }}' --required
;