nihilist/acme.sh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
f7e09af5c9
acme.sh/dnsapi
History
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>
2024-05-18 12:06:41 +03:00
..
dns_1984hosting.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_acmedns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_acmeproxy.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_active24.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_ad.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_ali.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_anx.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_artfiles.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_arvan.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_aurora.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_autodns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_aws.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_azion.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_azure.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_bookmyname.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_bunny.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_cf.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_clouddns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_cloudns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_cn.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_conoha.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_constellix.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_cpanel.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_curanet.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_cyon.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_da.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_ddnss.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_desec.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_df.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dgon.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dnsexit.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dnshome.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dnsimple.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dnsservices.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_doapi.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_domeneshop.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dp.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dpi.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dreamhost.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_duckdns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_durabledns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dyn.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dynu.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_dynv6.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_easydns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_edgedns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_euserv.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_exoscale.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_fornex.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_freedns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_gandi_livedns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_gcloud.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_gcore.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_gd.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_geoscaling.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_googledomains.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_he.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_hetzner.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_hexonet.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_hostingde.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_huaweicloud.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_infoblox.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_infomaniak.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_internetbs.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_inwx.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_ionos.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_ipv64.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_ispconfig.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_jd.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_joker.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_kappernet.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_kas.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_kinghost.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_knot.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_la.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_leaseweb.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_lexicon.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_limacity.sh Update dns_limacity.sh 2024-03-03 10:32:21 +01:00
dns_linode_v4.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_linode.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_loopia.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_lua.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_maradns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_me.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_miab.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_misaka.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_myapi.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_mydevil.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_mydnsjp.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_mythic_beasts.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_namecheap.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_namecom.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_namesilo.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_nanelo.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_nederhost.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_neodigit.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_netcup.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_netlify.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_nic.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_njalla.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_nm.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_nsd.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_nsone.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_nsupdate.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_nw.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_oci.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_one.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_online.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_openprovider.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_openstack.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_opnsense.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_ovh.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_pdns.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_pleskxml.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_pointhq.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_porkbun.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_rackcorp.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_rackspace.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_rage4.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_rcode0.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_regru.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_scaleway.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_schlundtech.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_selectel.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_selfhost.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_servercow.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_simply.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_tele3.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_tencent.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_transip.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_udr.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_ultra.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_unoeuro.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_variomedia.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_veesp.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_vercel.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_vscale.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_vultr.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_websupport.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_west_cn.sh Update dns_west_cn.sh 2023-11-07 07:20:25 +08:00
dns_world4you.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_yandex.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_yc.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_zilore.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_zone.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
dns_zonomi.sh DNS provider API: structured description 2024-05-18 12:06:41 +03:00
README.md update repo name 2020-01-30 12:06:39 +08:00

README.md

How to use DNS API

DNS api usage:

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