You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
acme.sh/dnsapi
Sergey Ponomarev 6b7b5caf54 DNS provider API: structured description
Instead of using comments declare info in a special variable.
Then the variable can be used to print the DNS API provider usage.
The usage can be parsed on UI and show all needed inputs for options.

The info is stored in plain string that it's both human-readable and easy to parse:

    dns_example_info='API name
     An extended description.
     Multiline.
    Domains: list of alternative domains to find
    Site: the dns provider website e.g. example.com
    Docs: Link to ACME.sh wiki for the provider
    Options:
     VARIABLE1 Title for the option1.
     VARIABLE2 Title for the option2. Default "default value".
     VARIABLE3 Title for the option3. Description to show on UI. Optional.
    Issues: Link to a support ticket on https://github.com/acmesh-official/acme.sh
    Author: First Lastname <authoremail@example.com>, Another Author <https://github.com/example>;
    '

Here:
VARIABLE1 will be required.
VARIABLE2 will be required too but will be populated with a "default value".
VARIABLE3 is optional and can be empty.

A DNS provider may have alternative options like CloudFlare may use API KEY or API Token.
You can use a second section OptionsAlt: section.

Some providers may have alternative names or domains e.g. Aliyun and AlibabaCloud.
Add them to Domains: section.

Signed-off-by: Sergey Ponomarev <stokito@gmail.com>
9 months ago
..
README.md update repo name 5 years ago
dns_1984hosting.sh DNS provider API: structured description 9 months ago
dns_acmedns.sh DNS provider API: structured description 9 months ago
dns_acmeproxy.sh DNS provider API: structured description 9 months ago
dns_active24.sh DNS provider API: structured description 9 months ago
dns_ad.sh DNS provider API: structured description 9 months ago
dns_ali.sh DNS provider API: structured description 9 months ago
dns_anx.sh DNS provider API: structured description 9 months ago
dns_artfiles.sh DNS provider API: structured description 9 months ago
dns_arvan.sh DNS provider API: structured description 9 months ago
dns_aurora.sh DNS provider API: structured description 9 months ago
dns_autodns.sh DNS provider API: structured description 9 months ago
dns_aws.sh DNS provider API: structured description 9 months ago
dns_azion.sh DNS provider API: structured description 9 months ago
dns_azure.sh DNS provider API: structured description 9 months ago
dns_bookmyname.sh DNS provider API: structured description 9 months ago
dns_bunny.sh DNS provider API: structured description 9 months ago
dns_cf.sh DNS provider API: structured description 9 months ago
dns_clouddns.sh DNS provider API: structured description 9 months ago
dns_cloudns.sh DNS provider API: structured description 9 months ago
dns_cn.sh DNS provider API: structured description 9 months ago
dns_conoha.sh DNS provider API: structured description 9 months ago
dns_constellix.sh DNS provider API: structured description 9 months ago
dns_cpanel.sh DNS provider API: structured description 9 months ago
dns_curanet.sh DNS provider API: structured description 9 months ago
dns_cyon.sh DNS provider API: structured description 9 months ago
dns_da.sh DNS provider API: structured description 9 months ago
dns_ddnss.sh DNS provider API: structured description 9 months ago
dns_desec.sh DNS provider API: structured description 9 months ago
dns_df.sh DNS provider API: structured description 9 months ago
dns_dgon.sh DNS provider API: structured description 9 months ago
dns_dnsexit.sh DNS provider API: structured description 9 months ago
dns_dnshome.sh DNS provider API: structured description 9 months ago
dns_dnsimple.sh DNS provider API: structured description 9 months ago
dns_dnsservices.sh DNS provider API: structured description 9 months ago
dns_doapi.sh DNS provider API: structured description 9 months ago
dns_domeneshop.sh DNS provider API: structured description 9 months ago
dns_dp.sh DNS provider API: structured description 9 months ago
dns_dpi.sh DNS provider API: structured description 9 months ago
dns_dreamhost.sh DNS provider API: structured description 9 months ago
dns_duckdns.sh DNS provider API: structured description 9 months ago
dns_durabledns.sh DNS provider API: structured description 9 months ago
dns_dyn.sh DNS provider API: structured description 9 months ago
dns_dynu.sh DNS provider API: structured description 9 months ago
dns_dynv6.sh DNS provider API: structured description 9 months ago
dns_easydns.sh DNS provider API: structured description 9 months ago
dns_edgedns.sh DNS provider API: structured description 9 months ago
dns_euserv.sh DNS provider API: structured description 9 months ago
dns_exoscale.sh DNS provider API: structured description 9 months ago
dns_fornex.sh DNS provider API: structured description 9 months ago
dns_freedns.sh DNS provider API: structured description 9 months ago
dns_gandi_livedns.sh DNS provider API: structured description 9 months ago
dns_gcloud.sh DNS provider API: structured description 9 months ago
dns_gcore.sh DNS provider API: structured description 9 months ago
dns_gd.sh DNS provider API: structured description 9 months ago
dns_geoscaling.sh DNS provider API: structured description 9 months ago
dns_googledomains.sh DNS provider API: structured description 9 months ago
dns_he.sh DNS provider API: structured description 9 months ago
dns_hetzner.sh DNS provider API: structured description 9 months ago
dns_hexonet.sh DNS provider API: structured description 9 months ago
dns_hostingde.sh DNS provider API: structured description 9 months ago
dns_huaweicloud.sh DNS provider API: structured description 9 months ago
dns_infoblox.sh DNS provider API: structured description 9 months ago
dns_infomaniak.sh DNS provider API: structured description 9 months ago
dns_internetbs.sh DNS provider API: structured description 9 months ago
dns_inwx.sh DNS provider API: structured description 9 months ago
dns_ionos.sh DNS provider API: structured description 9 months ago
dns_ipv64.sh DNS provider API: structured description 9 months ago
dns_ispconfig.sh DNS provider API: structured description 9 months ago
dns_jd.sh DNS provider API: structured description 9 months ago
dns_joker.sh DNS provider API: structured description 9 months ago
dns_kappernet.sh DNS provider API: structured description 9 months ago
dns_kas.sh DNS provider API: structured description 9 months ago
dns_kinghost.sh DNS provider API: structured description 9 months ago
dns_knot.sh DNS provider API: structured description 9 months ago
dns_la.sh DNS provider API: structured description 9 months ago
dns_leaseweb.sh DNS provider API: structured description 9 months ago
dns_lexicon.sh DNS provider API: structured description 9 months ago
dns_limacity.sh Update dns_limacity.sh 11 months ago
dns_linode.sh DNS provider API: structured description 9 months ago
dns_linode_v4.sh DNS provider API: structured description 9 months ago
dns_loopia.sh DNS provider API: structured description 9 months ago
dns_lua.sh DNS provider API: structured description 9 months ago
dns_maradns.sh DNS provider API: structured description 9 months ago
dns_me.sh DNS provider API: structured description 9 months ago
dns_miab.sh DNS provider API: structured description 9 months ago
dns_misaka.sh DNS provider API: structured description 9 months ago
dns_myapi.sh DNS provider API: structured description 9 months ago
dns_mydevil.sh DNS provider API: structured description 9 months ago
dns_mydnsjp.sh DNS provider API: structured description 9 months ago
dns_mythic_beasts.sh DNS provider API: structured description 9 months ago
dns_namecheap.sh DNS provider API: structured description 9 months ago
dns_namecom.sh DNS provider API: structured description 9 months ago
dns_namesilo.sh DNS provider API: structured description 9 months ago
dns_nanelo.sh DNS provider API: structured description 9 months ago
dns_nederhost.sh DNS provider API: structured description 9 months ago
dns_neodigit.sh DNS provider API: structured description 9 months ago
dns_netcup.sh DNS provider API: structured description 9 months ago
dns_netlify.sh DNS provider API: structured description 9 months ago
dns_nic.sh DNS provider API: structured description 9 months ago
dns_njalla.sh DNS provider API: structured description 9 months ago
dns_nm.sh DNS provider API: structured description 9 months ago
dns_nsd.sh DNS provider API: structured description 9 months ago
dns_nsone.sh DNS provider API: structured description 9 months ago
dns_nsupdate.sh DNS provider API: structured description 9 months ago
dns_nw.sh DNS provider API: structured description 9 months ago
dns_oci.sh DNS provider API: structured description 9 months ago
dns_one.sh DNS provider API: structured description 9 months ago
dns_online.sh DNS provider API: structured description 9 months ago
dns_openprovider.sh DNS provider API: structured description 9 months ago
dns_openstack.sh DNS provider API: structured description 9 months ago
dns_opnsense.sh DNS provider API: structured description 9 months ago
dns_ovh.sh DNS provider API: structured description 9 months ago
dns_pdns.sh DNS provider API: structured description 9 months ago
dns_pleskxml.sh DNS provider API: structured description 9 months ago
dns_pointhq.sh DNS provider API: structured description 9 months ago
dns_porkbun.sh DNS provider API: structured description 9 months ago
dns_rackcorp.sh DNS provider API: structured description 9 months ago
dns_rackspace.sh DNS provider API: structured description 9 months ago
dns_rage4.sh DNS provider API: structured description 9 months ago
dns_rcode0.sh DNS provider API: structured description 9 months ago
dns_regru.sh DNS provider API: structured description 9 months ago
dns_scaleway.sh DNS provider API: structured description 9 months ago
dns_schlundtech.sh DNS provider API: structured description 9 months ago
dns_selectel.sh DNS provider API: structured description 9 months ago
dns_selfhost.sh DNS provider API: structured description 9 months ago
dns_servercow.sh DNS provider API: structured description 9 months ago
dns_simply.sh DNS provider API: structured description 9 months ago
dns_tele3.sh DNS provider API: structured description 9 months ago
dns_tencent.sh DNS provider API: structured description 9 months ago
dns_transip.sh DNS provider API: structured description 9 months ago
dns_udr.sh DNS provider API: structured description 9 months ago
dns_ultra.sh DNS provider API: structured description 9 months ago
dns_unoeuro.sh DNS provider API: structured description 9 months ago
dns_variomedia.sh DNS provider API: structured description 9 months ago
dns_veesp.sh DNS provider API: structured description 9 months ago
dns_vercel.sh DNS provider API: structured description 9 months ago
dns_vscale.sh DNS provider API: structured description 9 months ago
dns_vultr.sh DNS provider API: structured description 9 months ago
dns_websupport.sh DNS provider API: structured description 9 months ago
dns_west_cn.sh Update dns_west_cn.sh 1 year ago
dns_world4you.sh DNS provider API: structured description 9 months ago
dns_yandex.sh DNS provider API: structured description 9 months ago
dns_yc.sh DNS provider API: structured description 9 months ago
dns_zilore.sh DNS provider API: structured description 9 months ago
dns_zone.sh DNS provider API: structured description 9 months ago
dns_zonomi.sh DNS provider API: structured description 9 months ago

README.md

How to use DNS API

DNS api usage:

https://github.com/acmesh-official/acme.sh/wiki/dnsapi