custom_ns

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

Overview

Name	custom_ns
Type	Resource
Id	cloudflare.custom_nameservers.custom_ns

Fields

The following fields are returned by SELECT queries:

list

List Account Custom Nameservers response

Name	Datatype	Description
ns_name	string (hostname)	The FQDN of the name server. (example: ns1.example.com)
dns_records	array	A and AAAA records associated with the nameserver. (x-stainless-collection-type: set)
ns_set	number	The number of the set that this name server belongs to.
status	string	Verification status of the nameserver. (moved, pending, verified) (example: verified)
zone_tag	string	Identifier. (example: 023e105f4ecef8ad9ca31a8372d0c353)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id		List an account's custom nameservers.
create	insert	account_id, ns_name
account_level_custom_nameservers_delete_account_custom_nameserver	delete	custom_ns_id, account_id

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
account_id	string	The Cloudflare account ID.
custom_ns_id	string (hostname)

SELECT examples

list

List an account's custom nameservers.

SELECT
ns_name,
dns_records,
ns_set,
status,
zone_tag
FROM cloudflare.custom_nameservers.custom_ns
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO cloudflare.custom_nameservers.custom_ns (
ns_name,
ns_set,
account_id
)
SELECT 
'{{ ns_name }}' /* required */,
{{ ns_set }},
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: custom_ns
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the custom_ns resource.
  - name: ns_name
    value: "{{ ns_name }}"
    description: |
      The FQDN of the name server.
  - name: ns_set
    value: {{ ns_set }}
    description: |
      The number of the set that this name server belongs to.
    default: 1

DELETE examples

account_level_custom_nameservers_delete_account_custom_nameserver

No description available.

DELETE FROM cloudflare.custom_nameservers.custom_ns
WHERE custom_ns_id = '{{ custom_ns_id }}' --required
AND account_id = '{{ account_id }}' --required
;