YAML for domains

Storing domain definitions

By default, YAML is stored in the app. However, you can also keep the configuration in your git repository. That way, you can change domain definitions by editing the files in the repository. When choosing to store YAML definition in the repository you have to specify project, branch and path to the YAML file.

yaml
example.com:
  records:
    '@':
    - type: SOA
      values: bison.live.page. hostmaster.example.com. 2025013101 10800 3600 604800 3600
    - type: NS
      values:
      - bison.live.page.
      - lynx.live.page.
      - stork.live.page.
      - wolf.live.page.
    - type: A
      values: 192.0.2.1
    - type: AAAA
      values: 2001:db8::1
    - type: CAA
      values: 0 issue "letsencrypt.org"
    - type: MX
      values: 10 mail.example.com
    - type: TXT
      values: v=spf1 include:_spf.example.com -all
    sip:
    - type: NAPTR
      values: 10 100 "S" "SIP+D2U" "!^.*$!sip:info@example.com!" _sip._udp.example.com
    www:
    - type: CNAME
      values: example.com
    _service._protocol:
    - type: SRV
      values: 10 5 5060 sip.example.com

Domain

Name	Type	Description
domain `required`	string	Full name of the domain without subdomains. Contains `records` key. Immutable, generated automatically.
records `required`	subdomain[]	Contains list of subdomains. Immutable, generated automatically.

Subdomain

Name	Type	Description
subdomain `required`	string	Subdomain name without the domain name. Can contain `@` to refer to a root record. Can begin with `*`. Contains a list of types of records.

Record

Name	Type	Description
type	string	Type of the record. Possible balues: A, AAAA, TXT, CNAME, SOA, NS, CAA, SRV, NAPTR, MX
values	string/string[]	Value of the record. Has to be according to the DNS record rules.
ttl	Integer	Time to live. Value in seconds. Default: 3600 (1hr).

Last modified on Feb 28, 2025

YAML templates