PluginVersion 3.0.0

Namecheap DNS

Adds and changes DNS records for the domains you list, registered at Namecheap and using Namecheap DNS, without ever losing an existing record.

Download namecheap-plugin-3.0.0.zip Source

5.8 MB. Check the download against its SHA-256 below.

What it contains

Settings: Domains, Mode, Default TTL, Client IP, Use the sandbox
Keys: API user, API key
Sign-ins: Namecheap
Events: A domain's records were changed (ensure, remove or restore in apply mode), written and checked. One DNS record was added, changed or removed by ensure, remove or restore in apply mode, written and checked. At most 25 per command; changed covers the rest. A command was refused or failed: the domain is not listed or not on Namecheap DNS, the records could not be read, the arguments were wrong, or a write failed.
Skills: plugin-namecheap-plugin

Documentation

What it does

It sets A, AAAA, CNAME, MX, TXT and CAA records: a custom domain's verification and certificate records for a hosted app, or a mailbox's MX, SPF, DKIM and DMARC records. It may also remove a URL redirect record, so an app's A record can take the host's place, but never adds or changes one. Every change reads the domain's current records, changes only the one named, saves the records before the change as a backup that restore puts back, and reads them again after writing to check every earlier record is still there. After each change it asks the domain's own name servers directly, for up to a minute, and says per record whether it is live on them; the check command asks them about any name. Dry run by default: it shows the records before and after and changes nothing until you set mode to apply.

The setup command checks that API access is on, that this computer's address is on Namecheap's API allow-list (naming the address), and that each listed domain is in the account and on Namecheap DNS.

What it needs

Accounts you connect

Namecheap required

an Apikey account

The Namecheap account's API key: an API-key connection with the Namecheap preset (API user, API key, Whitelisted IP), added and assigned to the team in Team settings, Connections.

Keys set on the Host

A plugin names its secret fields; you choose the key each one reads when you hire it.

apiUserrequired: Now held by the Namecheap API-key connection bound to the namecheap slot, set in Team settings, Connections. Declared only so an update carries a value this member already had over into that connection.
apiKeyrequired: Now held by the Namecheap API-key connection bound to the namecheap slot, set in Team settings, Connections. Declared only so an update carries a value this member already had over into that connection.

Settings you choose

domainsoptional: The only domains this member may read or change, such as example.com. Each must be in the Namecheap account and use Namecheap DNS.
modeoptional: dryrun shows each change as the records before and after and changes nothing. apply makes the change, after saving a backup.
defaultTtloptional: The TTL in seconds ensure gives a record it adds when the command names none. 1799 is Namecheap's Automatic; a ttl the command names always wins.
clientIpoptional: Not used with a Namecheap connection, whose required Whitelisted IP is the address sent. Used only when the namecheap slot holds an Other API-key connection with no clientIp field: this computer's public IPv4 address, as on Namecheap's API allow-list. Empty here too: the plugin finds it itself.
sandboxoptional: Send every call to Namecheap's sandbox API instead of the real one. The sandbox has its own account, API user and API key.

Setting it up

Accounts you connect

Namecheap required

an Apikey account

The Namecheap account's API key: an API-key connection with the Namecheap preset (API user, API key, Whitelisted IP), added and assigned to the team in Team settings, Connections.

Settings and secrets

Domains optional

No default.

The only domains this member may read or change, such as example.com. Each must be in the Namecheap account and use Namecheap DNS.

Mode optional

Default: dryrun

dryrun shows each change as the records before and after and changes nothing. apply makes the change, after saving a backup.

Default TTL optional

Default: 1799

The TTL in seconds ensure gives a record it adds when the command names none. 1799 is Namecheap's Automatic; a ttl the command names always wins.

Client IP optional

No default.

Not used with a Namecheap connection, whose required Whitelisted IP is the address sent. Used only when the namecheap slot holds an Other API-key connection with no clientIp field: this computer's public IPv4 address, as on Namecheap's API allow-list. Empty here too: the plugin finds it itself.

Use the sandbox optional

Default: Off

Send every call to Namecheap's sandbox API instead of the real one. The sandbox has its own account, API user and API key.

API user secret, optional

Now held by the Namecheap API-key connection bound to the namecheap slot, set in Team settings, Connections. Declared only so an update carries a value this member already had over into that connection.

Entered once per member and kept encrypted; shown as you type it.

API key secret, optional

Entered once per member and kept encrypted; hidden as you type it.

Details

Kind: Plugin
Version: 3.0.0
Plugins: namecheap-plugin 3.0.0
Platforms: Linux x64, Linux Arm64
Size: 5.8 MB (6,118,917 bytes)
SHA-256: 2b0ba0375541e66950a17a46d194fa709eeca6b573cb28866533978725b76302
Download: namecheap-plugin-3.0.0.zip
Source: github.com/djlsystems/Yawble-packages/tree/main/packages/namecheap-plugin
License: Apache License 2.0 (Apache-2.0), separate from the license of Yawble itself

How to install

In Yawble, open Marketplace, find Namecheap DNS under Browse and press Get. Or download the .zip, then in Yawble:

Admin
Plugins
Install from a folder

You see what the package adds before it goes in, and you connect its accounts and set its keys afterwards.