Skip to main content

Dnsimple/zones

@webframp/dnsimple/zonesv2026.11.03.4· Apache-2.0· 17d agoBEHAVIORS
01README

DNSimple Zones — zones, records, batch changes, zone file, distribution checks, NS records, activation, and DNS analytics

02Release Notes

2026.11.03.4

Changed: Bump zod 4.6.5 → 4.6.7

2026.11.03.3

Fixed: a result named from two path values, such as a record under a zone, could share a name with a result named from one value. Those names now end in a 16-character hash, for example example.com-12345-. Results stored under the old name stay where they are and are not updated.

Fixed: the DNS analytics result type no longer lists the string type twice in a union. Parsing behaves as before.

Changed: list methods store truncated: true when a response reports more pages than were fetched, instead of always storing false. Nothing changes for lists DNSimple returns in one page.

03Behaviors1
@webframp/dnsimple/zonesv2026.11.03.4dnsimple/zones.ts

Global Arguments

ArgumentTypeDescription
apiToken?stringDNSimple API access token (account or user token). Wire it with ${{ vault.get("dnsimple", "ACCESS_TOKEN") }}; never pass the literal value. The DNSIMPLE_TOKEN environment variable is read as a fallback, but it is not redacted and is not recommended.
accountId?stringNumeric DNSimple account ID that account-scoped paths use. The account model's whoami method returns it.
environment?enumDNSimple API environment. The sandbox has its own accounts and tokens.
fn list_zones(name_like?: string, sort?: enum)
List zones
ArgumentTypeDescription
name_like?stringOnly include results with a name field containing the given string
sort?enumSort results. Default sorting is by name ascending.
fn get_zone(zone: string)
Retrieve a zone
ArgumentTypeDescription
zonestringThe zone name
fn get_zone_file(zone: string)
Download a zone file
ArgumentTypeDescription
zonestringThe zone name
fn check_zone_distribution(zone: string)
Check zone distribution
ArgumentTypeDescription
zonestringThe zone name
fn update_zone_ns_records(zone: string, body?: union)
Update a zone's NS records
ArgumentTypeDescription
zonestringThe zone name
body?union
fn list_zone_records(zone: string, name_like?: string, name?: string, type?: string, sort?: enum)
List zone records
ArgumentTypeDescription
zonestringThe zone name
name_like?stringOnly include results with a name field containing the given string
name?stringOnly include results with a name field exactly matching the given string
type?stringOnly include results with a type field exactly matching the given string
sort?enumSort results. Default sorting is by name ascending.
fn create_zone_record(zone: string, name: string, type: enum, content: string, ttl?: number, priority?: number, regions?: array, integrated_zones?: array)
Create a zone record
ArgumentTypeDescription
zonestringThe zone name
namestring
typeenumThe type of DNS record. Supported DNS record types are listed below. Note...
contentstring
ttl?numberThe Time To Live (TTL) value for the entry, in seconds.
priority?number
regions?array
integrated_zones?array
fn get_zone_record(zone: string, zonerecord: union)
Retrieve a zone record
ArgumentTypeDescription
zonestringThe zone name
zonerecordunionThe zone record id
fn update_zone_record(zone: string, zonerecord: union, name?: string, content?: string, ttl?: number, priority?: number, regions?: array, integrated_zones?: array)
Update a zone record
ArgumentTypeDescription
zonestringThe zone name
zonerecordunionThe zone record id
name?string
content?string
ttl?numberThe Time To Live (TTL) value for the entry, in seconds.
priority?number
regions?array
integrated_zones?array
fn delete_zone_record(zone: string, zonerecord: union)
Delete a zone record
ArgumentTypeDescription
zonestringThe zone name
zonerecordunionThe zone record id
fn batch_change_zone_records(zone: string, creates?: array, updates?: array, deletes?: array)
Batch create, update, and/or delete records in a zone
ArgumentTypeDescription
zonestringThe zone name
creates?arrayZone records to create
updates?arrayZone records to update
deletes?arrayZone record IDs to delete
fn check_zone_record_distribution(zone: string, zonerecord: union)
Check zone record distribution
ArgumentTypeDescription
zonestringThe zone name
zonerecordunionThe zone record id
fn activate_zone_service(zone: string)
Activate a zone DNS service
ArgumentTypeDescription
zonestringThe zone name
fn deactivate_zone_service(zone: string)
Deactivate a zone DNS service
ArgumentTypeDescription
zonestringThe zone name
fn query_dns_analytics(start_date?: string, end_date?: string, groupings?: string, sort?: string)
Analytics about DNS queries
ArgumentTypeDescription
start_date?stringOnly include results after the given date. Format is ISO8601 (YYYY-MM-DD)....
end_date?stringOnly include results before the given date. Format is ISO8601 (YYYY-MM-DD)....
groupings?stringHow to group the results of the account's DNS analytics. No groupings will...
sort?stringSort results. Default sorting policy is by ascending date, then ascending...

Resources

zones(infinite)— List zones
zone(infinite)— Retrieve a zone
zone_file(infinite)— Download a zone file
check_zone_distribution(infinite)— Check zone distribution
zone_ns_records(infinite)— Update a zone's NS records
zone_records(infinite)— List zone records
zone_record(infinite)— Create a zone record
batch_change_zone_records(infinite)— Batch create, update, and/or delete records in a zone
check_zone_record_distribution(infinite)— Check zone record distribution
activate_zone_service(infinite)— Activate a zone DNS service
deactivate_zone_service(infinite)— Deactivate a zone DNS service
query_dns_analytics(infinite)— Analytics about DNS queries
04Previous Versions1
2026.11.03.3Apache-2.0

2026.11.03.3

Fixed: a result named from two path values, such as a record under a zone, could share a name with a result named from one value. Those names now end in a 16-character hash, for example example.com-12345-. Results stored under the old name stay where they are and are not updated.

Fixed: the DNS analytics result type no longer lists the string type twice in a union. Parsing behaves as before.

Changed: list methods store truncated: true when a response reports more pages than were fetched, instead of always storing false. Nothing changes for lists DNSimple returns in one page.

05Stats
A
100 / 100
Downloads
6
Archive size
26.3 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels