declare function HEDNS_DDNS_KEY(key: string): RecordModifier;

declare const HEDNS_DYNAMIC_OFF: RecordModifier;

declare const HEDNS_DYNAMIC_ON: RecordModifier;

* Hurricane Electric DNS

* [HEDNS_DYNAMIC_ON](language-reference/record-modifiers/HEDNS_DYNAMIC_ON.md)

* [HEDNS_DYNAMIC_OFF](language-reference/record-modifiers/HEDNS_DYNAMIC_OFF.md)

* [HEDNS_DDNS_KEY](language-reference/record-modifiers/HEDNS_DDNS_KEY.md)

name: HEDNS_DDNS_KEY

parameters:

- key

parameter_types:

key: string

ts_return: RecordModifier

provider: HEDNS

`HEDNS_DDNS_KEY` enables Dynamic DNS on a record managed by the Hurricane Electric DNS provider and sets a specific DDNS key (token). This implies [`HEDNS_DYNAMIC_ON`](HEDNS_DYNAMIC_ON.md).

The DDNS key can then be used with the HE DDNS update API (`https://dyn.dns.he.net/nic/update`) to update the record's value.

**Note:** DDNS keys are **write-only**. dnscontrol sets the key on the provider but cannot read back the current key. This means a key-only change (same record data, new key) will not be detected as a difference. To force an update, also change another field such as the TTL.

{% code title="dnsconfig.js" %}

D("example.com", REG_NONE, DnsProvider(DSP_HEDNS),

A("dyn", "0.0.0.0", HEDNS_DDNS_KEY("my-secret-token")),

AAAA("dyn6", "::1", HEDNS_DDNS_KEY("another-token")),

);

{% endcode %}

name: HEDNS_DYNAMIC_OFF

parameters: []

ts_return: RecordModifier

provider: HEDNS

`HEDNS_DYNAMIC_OFF` explicitly disables Dynamic DNS on a record managed by the Hurricane Electric DNS provider. This will clear any DDNS key previously associated with the record.

Use this modifier when you want to ensure a record that was previously dynamic is returned to a static state.

{% code title="dnsconfig.js" %}

D("example.com", REG_NONE, DnsProvider(DSP_HEDNS),

A("static", "5.6.7.8", HEDNS_DYNAMIC_OFF),

);

{% endcode %}

name: HEDNS_DYNAMIC_ON

parameters: []

ts_return: RecordModifier

provider: HEDNS

`HEDNS_DYNAMIC_ON` enables [Dynamic DNS](https://dns.he.net/) on a record managed by the Hurricane Electric DNS provider. When enabled, HE DNS assigns a DDNS key to the record that can be used with the HE DDNS update API (`https://dyn.dns.he.net/nic/update`).

If a record is already dynamic, its dynamic state is preserved across modifications even without explicitly specifying this modifier.

To set a specific DDNS key, use [`HEDNS_DDNS_KEY()`](HEDNS_DDNS_KEY.md) instead.

{% code title="dnsconfig.js" %}

D("example.com", REG_NONE, DnsProvider(DSP_HEDNS),

A("dyn", "0.0.0.0", HEDNS_DYNAMIC_ON),

AAAA("dyn6", "::1", HEDNS_DYNAMIC_ON),

);

{% endcode %}

This provider supports the following record-level metadata:

| Modifier | Description |

|---|---|

| `HEDNS_DYNAMIC_ON` | Enable [Dynamic DNS](https://dns.he.net/) on the record. The record will be assigned a DDNS key that can be used to update its value via the HE DDNS API (`https://dyn.dns.he.net/nic/update`). |

| `HEDNS_DYNAMIC_OFF` | Explicitly disable Dynamic DNS on the record. **Warning:** this will clear any associated DDNS key. |

| `HEDNS_DDNS_KEY("key")` | Enable Dynamic DNS and set a specific DDNS key (token) on the record. Implies `HEDNS_DYNAMIC_ON`. |

* When a record has Dynamic DNS enabled and is subsequently modified by dnscontrol (e.g. TTL change), the dynamic flag is **preserved** automatically. You do not need to re-specify `HEDNS_DYNAMIC_ON` on every run unless you want to be explicit.

* If you do not specify any `HEDNS_DYNAMIC_*` modifier on a record that is already dynamic on the provider, the dynamic state is **inherited** — the record stays dynamic.

* DDNS keys are **write-only**: dnscontrol will set the key you specify but cannot read back the current key from HE DNS. This means:

* A key-only change (same record data, new key) requires changing another field (e.g. TTL) to trigger an update.

* The `get-zones` export will include `HEDNS_DYNAMIC_ON` for dynamic records but will not include the DDNS key.

// Standard static record

// Dynamic DNS record (HE DNS assigns/preserves the DDNS key)

A("dyn", "0.0.0.0", HEDNS_DYNAMIC_ON),

// Dynamic DNS record with a specific DDNS key

A("dyn2", "0.0.0.0", HEDNS_DDNS_KEY("my-secret-token")),

// Dynamic AAAA record

AAAA("dyn6", "::1", HEDNS_DYNAMIC_ON),

// Explicitly non-dynamic record (clears any prior DDNS key)

A("static", "5.6.7.8", HEDNS_DYNAMIC_OFF),

func hednsDynamicA(name, target, status string) *models.RecordConfig {

r := a(name, target)

r.Metadata = make(map[string]string)

r.Metadata["hedns_dynamic"] = status

return r

}

func hednsDdnsKeyA(name, target, key string) *models.RecordConfig {

r := a(name, target)

r.Metadata = make(map[string]string)

r.Metadata["hedns_dynamic"] = "on"

r.Metadata["hedns_ddns_key"] = key

return r

}

func hednsDynamicAAAA(name, target, status string) *models.RecordConfig {

r := aaaa(name, target)

r.Metadata = make(map[string]string)

r.Metadata["hedns_dynamic"] = status

return r

}

func hednsDdnsKeyAAAA(name, target, key string) *models.RecordConfig {

r := aaaa(name, target)

r.Metadata = make(map[string]string)

r.Metadata["hedns_dynamic"] = "on"

r.Metadata["hedns_ddns_key"] = key

return r

}

func hednsDynamicTXT(name, target, status string) *models.RecordConfig {

r := txt(name, target)

r.Metadata = make(map[string]string)

r.Metadata["hedns_dynamic"] = status

return r

}

// HEDNS: Dynamic DNS

testgroup("HEDNS_DYNAMIC A lifecycle",

only("HEDNS"),

// Create a dynamic A record and verify target changes preserve the flag.

tc("Create dynamic A", hednsDynamicA("hdyn", "1.2.3.4", "on")),

tc("Change target preserves dynamic", hednsDynamicA("hdyn", "5.6.7.8", "on")),

// Toggle dynamic off, then back on.

tc("Turn off dynamic", hednsDynamicA("hdyn", "5.6.7.8", "off")),

tc("Turn on dynamic", hednsDynamicA("hdyn", "5.6.7.8", "on")),

// Change target without specifying hedns_dynamic — it should stay dynamic.

tc("Inherit dynamic on modify", a("hdyn", "10.0.0.1")),

// Create a non-dynamic record alongside.

tc("Add static record", a("hdyn", "10.0.0.1"), a("hstatic", "2.2.2.2")),

),

testgroup("HEDNS_DYNAMIC AAAA+TXT",

only("HEDNS"),

tc("Create dynamic AAAA", hednsDynamicAAAA("hdynv6", "2607:f8b0:4006:820::2006", "on")),

tc("Change dynamic AAAA target", hednsDynamicAAAA("hdynv6", "2607:f8b0:4006:820::2013", "on")),

tc("Create dynamic TXT", hednsDynamicTXT("hdyntxt", "dynamic-value", "on")),

tc("Turn off dynamic TXT", hednsDynamicTXT("hdyntxt", "dynamic-value", "off")),

),

testgroup("HEDNS_DDNS_KEY",

only("HEDNS"),

// Setting a DDNS key implicitly enables dynamic.

tc("Create A with DDNS key (implicit dynamic)", hednsDdnsKeyA("hkey", "1.2.3.4", "key1")),

// Change target and key together.

tc("Change target + key", hednsDdnsKeyA("hkey", "5.6.7.8", "key2")),

// AAAA with DDNS key.

tc("Create AAAA with DDNS key", hednsDdnsKeyAAAA("hkeyv6", "2607:f8b0:4006:820::2006", "v6key")),

tc("Change AAAA target + key", hednsDdnsKeyAAAA("hkeyv6", "2607:f8b0:4006:820::2013", "newv6key")),

),

testgroup("HEDNS_DYNAMIC mixed records",

only("HEDNS"),

tc("Create mix of dynamic and static",

hednsDynamicA("hdmix-dyn", "1.1.1.1", "on"),

a("hdmix-static", "2.2.2.2"),

),

tc("Modify only the static record",

hednsDynamicA("hdmix-dyn", "1.1.1.1", "on"),

a("hdmix-static", "3.3.3.3"),

),

),

var HEDNS_DYNAMIC_ON = { hedns_dynamic: 'on' };

var HEDNS_DYNAMIC_OFF = { hedns_dynamic: 'off' };

function HEDNS_DDNS_KEY(key) {

return { hedns_dynamic: 'on', hedns_ddns_key: key };