Skip to main content

Dnsimple/registrar

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

DNSimple Registrar — registration, renewal, transfer, restore, delegation, WHOIS privacy, transfer lock, auto-renewal, registrant changes, and prices

02Release Notes

2026.11.03.4

Changed: Bump zod 4.6.5 → 4.6.7

2026.11.03.3

Fixed: transfer_domain no longer requires auth_code. DNSimple's own description limits it to TLDs that use authorization-based transfers, so a transfer for any other TLD was rejected before a request was sent. DNSimple still refuses a transfer that needs a code and does not get one.

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.

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/registrarv2026.11.03.4dnsimple/registrar.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 check_domain(domain: string)
Check domain
ArgumentTypeDescription
domainstringThe domain name or id
fn get_domain_prices(domain: string)
Get prices for a domain
ArgumentTypeDescription
domainstringThe domain name or id
fn register_domain(domain: string, registrant_id: number, whois_privacy?: boolean, auto_renew?: boolean, trustee?: boolean, extended_attributes?: record, premium_price?: string, linked_provider?: string)
Billable: Register a domain
ArgumentTypeDescription
domainstringThe domain name or id
registrant_idnumberThe ID of an existing contact in your account.
whois_privacy?booleanSet to true will attempt to purchase/enable the whois privacy as part of the...
auto_renew?booleanSet to true to enable the auto-renewal of the domain. Default: false.
trustee?booleanSet to true will attempt to purchase/enable trustee service as part of the...
extended_attributes?recordRequired for TLDs that require extended attributes.
premium_price?stringRequired as confirmation of the price, only if the domain is premium.
linked_provider?stringThe nickname of a linked provider to register the domain through. If left...
fn get_domain_registration(domain: string, domainregistration: union)
Retrieve a domain registration
ArgumentTypeDescription
domainstringThe domain name or id
domainregistrationunionThe domain registration id
fn transfer_domain(domain: string, registrant_id: number, auth_code?: string, whois_privacy?: boolean, auto_renew?: boolean, trustee?: boolean, extended_attributes?: record, premium_price?: string)
Billable: Transfer a domain
ArgumentTypeDescription
domainstringThe domain name or id
registrant_idnumberThe ID of an existing contact in your account.
auth_code?string
whois_privacy?booleanSet to true will attempt to purchase/enable the whois privacy as part of the...
auto_renew?booleanSet to true to enable the auto-renewal of the domain. Default: false.
trustee?booleanSet to true to use a trustee service for the transfer. An extra cost may...
extended_attributes?recordRequired for TLDs that require extended attributes.
premium_price?stringRequired as confirmation of the price, only if the domain is premium.
fn get_domain_transfer(domain: string, domaintransfer: union)
Retrieve a domain transfer
ArgumentTypeDescription
domainstringThe domain name or id
domaintransferunionThe domain transfer id
fn cancel_domain_transfer(domain: string, domaintransfer: union)
Cancel a domain transfer
ArgumentTypeDescription
domainstringThe domain name or id
domaintransferunionThe domain transfer id
fn renew_domain(domain: string, period: number, premium_price?: string)
Billable: Renew a domain
ArgumentTypeDescription
domainstringThe domain name or id
periodnumber
premium_price?stringRequired as confirmation of the price, only if the domain is premium.
fn get_domain_renewal(domain: string, domainrenewal: union)
Retrieve a domain renewal
ArgumentTypeDescription
domainstringThe domain name or id
domainrenewalunionThe domain renewal id
fn restore_domain(domain: string, premium_price?: string)
Billable: Restore a domain
ArgumentTypeDescription
domainstringThe domain name or id
premium_price?stringRequired as confirmation of the price, only if the domain is premium.
fn get_domain_restore(domain: string, domainrestore: union)
Retrieve a domain restore
ArgumentTypeDescription
domainstringThe domain name or id
domainrestoreunionThe domain restore id
fn authorize_domain_transfer_out(domain: string)
Authorize a domain transfer out
ArgumentTypeDescription
domainstringThe domain name or id
fn get_domain_delegation(domain: string)
List domain name servers
ArgumentTypeDescription
domainstringThe domain name or id
fn change_domain_delegation(domain: string, items: array)
Change domain name servers
ArgumentTypeDescription
domainstringThe domain name or id
itemsarray
fn change_domain_delegation_to_vanity(domain: string, items: array)
Delegate to vanity name servers
ArgumentTypeDescription
domainstringThe domain name or id
itemsarray
fn change_domain_delegation_from_vanity(domain: string)
De-delegate from vanity name servers
ArgumentTypeDescription
domainstringThe domain name or id
fn get_domain_transfer_lock(domain: string)
Domain transfer lock status
ArgumentTypeDescription
domainstringThe domain name or id
fn enable_domain_transfer_lock(domain: string)
Enable domain transfer lock
ArgumentTypeDescription
domainstringThe domain name or id
fn disable_domain_transfer_lock(domain: string)
Disable domain transfer lock
ArgumentTypeDescription
domainstringThe domain name or id
fn enable_domain_auto_renewal(domain: string)
Enable domain auto-renewal
ArgumentTypeDescription
domainstringThe domain name or id
fn disable_domain_auto_renewal(domain: string)
Disable domain auto-renewal
ArgumentTypeDescription
domainstringThe domain name or id
fn enable_whois_privacy(domain: string)
Billable: Enable WHOIS privacy
ArgumentTypeDescription
domainstringThe domain name or id
fn disable_whois_privacy(domain: string)
Disable WHOIS privacy
ArgumentTypeDescription
domainstringThe domain name or id
fn list_registrant_changes(sort?: enum, state?: enum, domain_id?: string, contact_id?: string)
List registrant changes
ArgumentTypeDescription
sort?enumSort results. Default sorting is by id.
state?enumOnly include results with a state field exactly matching the given string
domain_id?stringOnly include results with a domain_id field exactly matching the given string
contact_id?stringOnly include results with a contact_id field exactly matching the given string
fn create_registrant_change(domain_id: union, contact_id: union, extended_attributes?: record)
Start registrant change
ArgumentTypeDescription
domain_idunion
contact_idunion
extended_attributes?record
fn check_registrant_change(domain_id: union, contact_id: union)
Check registrant change requirements
ArgumentTypeDescription
domain_idunion
contact_idunion
fn get_registrant_change(registrantchange: union)
Retrieve a registrant change
ArgumentTypeDescription
registrantchangeunionThe registrant change id
fn delete_registrant_change(registrantchange: union)
Cancel a registrant change
ArgumentTypeDescription
registrantchangeunionThe registrant change id

Resources

check_domain(infinite)— Check domain
domain_prices(infinite)— Get prices for a domain
register_domain(infinite)— Billable: Register a domain
domain_registration(infinite)— Retrieve a domain registration
transfer_domain(infinite)— Billable: Transfer a domain
domain_transfer(infinite)— Retrieve a domain transfer
cancel_domain_transfer(infinite)— Cancel a domain transfer
renew_domain(infinite)— Billable: Renew a domain
domain_renewal(infinite)— Retrieve a domain renewal
restore_domain(infinite)— Billable: Restore a domain
domain_restore(infinite)— Retrieve a domain restore
authorize_domain_transfer_out(infinite)— Authorize a domain transfer out
domain_delegation(infinite)— List domain name servers
change_domain_delegation(infinite)— Change domain name servers
change_domain_delegation_to_vanity(infinite)— Delegate to vanity name servers
change_domain_delegation_from_vanity(infinite)— De-delegate from vanity name servers
domain_transfer_lock(infinite)— Domain transfer lock status
enable_domain_transfer_lock(infinite)— Enable domain transfer lock
disable_domain_transfer_lock(infinite)— Disable domain transfer lock
enable_domain_auto_renewal(infinite)— Enable domain auto-renewal
disable_domain_auto_renewal(infinite)— Disable domain auto-renewal
enable_whois_privacy(infinite)— Billable: Enable WHOIS privacy
disable_whois_privacy(infinite)— Disable WHOIS privacy
registrant_changes(infinite)— List registrant changes
registrant_change(infinite)— Start registrant change
check_registrant_change(infinite)— Check registrant change requirements
delete_registrant_change(infinite)— Cancel a registrant change
04Previous Versions1
2026.11.03.3Apache-2.0

2026.11.03.3

Fixed: transfer_domain no longer requires auth_code. DNSimple's own description limits it to TLDs that use authorization-based transfers, so a transfer for any other TLD was rejected before a request was sent. DNSimple still refuses a transfer that needs a code and does not get one.

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.

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
4
Archive size
27.8 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