github
/
acme.sh
mirror of https://github.com/acmesh-official/acme.sh
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated dnsapi (markdown)

master
Sergey Ponomarev 2023-08-15 11:52:44 +03:00
parent d66d1efa5a
commit 7cb8c126c6
1 changed files with 160 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

177
dnsapi.md

@ -160,7 +160,6 @@ https://github.com/acmesh-official/acme.sh/wiki/DNS-alias-mode
<a name="dns_cf" />
## 1. CloudFlare Option:
Cloudflare Domain API offers two methods to automatically issue certs.
@ -177,9 +176,11 @@ export CF_Email="<youremail@example.com>"
export CF_Token="<token>"
export CF_Account_ID="<id>"
```
In order to use the new token, the token currently needs access read access to Zone.Zone, and write access to Zone.DNS, across all Zones. See [Issue #2398](https://github.com/Neilpang/acme.sh/issues/2398) for more info.
In order to use the new token, the token currently needs access read access to Zone.Zone, and write access to Zone.DNS, across all Zones.
See [Issue #2398](https://github.com/acmesh-official/acme.sh/issues/2398) for more info.
Alternatively, if the certificate only covers a single zone, you can restrict the API Token only for write access to Zone.DNS for a single domain, and then specify the `CF_Zone_ID` directly:
Alternatively, if the certificate only covers a single zone, you can restrict the API Token only for write access
to Zone.DNS for a single domain, and then specify the `CF_Zone_ID` directly:
```sh
export CF_Token="<token>"
@ -269,7 +270,7 @@ The `PDNS_Url`, `PDNS_ServerId`, `PDNS_Token` and `PDNS_Ttl` will be saved in `~
## 6. Use OVH, Kimsufi, So you Start API to automatically issue cert
https://github.com/Neilpang/acme.sh/wiki/How-to-use-OVH-domain-api
See [How to use OVH domain API](https://github.com/acmesh-official/acme.sh/wiki/How-to-use-OVH-domain-api)
<a name="dns_nsupdate" />
@ -383,7 +384,7 @@ The `ME_Key` and `ME_Secret` will be saved in `~/.acme.sh/account.conf` and will
## 10. Use Amazon Route53 domain API
https://github.com/Neilpang/acme.sh/wiki/How-to-use-Amazon-Route53-API
See [How to use Amazon Route53 API](https://github.com/acmesh-official/acme.sh/wiki/How-to-use-Amazon-Route53-API)
```sh
export AWS_ACCESS_KEY_ID="<key id>"
@ -465,8 +466,7 @@ Ok, let's issue a cert now:
./acme.sh --issue --dns dns_ad -d example.com -d www.example.com
```
The `AD_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused
when needed.
The `AD_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_linode_v4" />
@ -497,8 +497,7 @@ Ok, let's issue a cert now:
./acme.sh --issue --dns dns_linode_v4 --dnssleep 900 -d example.com -d www.example.com
```
The `LINODE_V4_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be
reused when needed.
The `LINODE_V4_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_freedns" />
@ -530,8 +529,7 @@ Note that you cannot use acme.sh automatic DNS validation for FreeDNS public dom
you create under a FreeDNS public domain. You must own the top level domain in order to automatically
validate with acme.sh at FreeDNS.
If you have any issues with FreeDNS API please report them here...
https://github.com/Neilpang/acme.sh/issues/2305
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2305)
<a name="dns_cyon" />
@ -594,7 +592,8 @@ include: /etc/knot/acme.key
Next, configure your zone to allow dynamic updates.
Dynamic updates for the zone are allowed via proper ACL rule with the `update` action. For in-depth instructions, please see [Knot DNS's documentation](https://www.knot-dns.cz/documentation/).
Dynamic updates for the zone are allowed via proper ACL rule with the `update` action.
For in-depth instructions, please see [Knot DNS's documentation](https://www.knot-dns.cz/documentation/).
```sh
acl:
@ -650,7 +649,8 @@ Ok, let's issue a cert now:
## 21. Use ClouDNS.net API
You need to set the HTTP API user ID and password credentials. See: https://www.cloudns.net/wiki/article/42/. For security reasons, it's recommended to use a sub user ID that only has access to the necessary zones, as a regular API user has access to your entire account.
You need to set the HTTP API user ID and password credentials. See: https://www.cloudns.net/wiki/article/42/.
For security reasons, it's recommended to use a sub user ID that only has access to the necessary zones, as a regular API user has access to your entire account.
```sh
# Use this for a sub auth ID
@ -744,11 +744,9 @@ To issue the cert just specify the `dns_dnsimple` API.
./acme.sh --issue --dns dns_dnsimple -d example.com
```
The `DNSimple_OAUTH_TOKEN` will be saved in `~/.acme.sh/account.conf` and will
be reused when needed.
The `DNSimple_OAUTH_TOKEN` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
If you have any issues with this integration please report them to
https://github.com/pho3nixf1re/acme.sh/issues.
Report any bugs or issues [here](https://github.com/pho3nixf1re/acme.sh/issues)
<a name="dns_nsone" />
@ -800,7 +798,7 @@ And now you can issue certs with:
```
If you had Two-step Authentication enabled, make sure to change your security setting, read this guide for help: [Using API with Two-step Authentication](https://www.name.com/support/articles/360007989433-Using-API-with-Two-step-Authentication)
For issues, please report to https://github.com/raidenii/acme.sh/issues.
Report any bugs or issues [here](https://github.com/raidenii/acme.sh/issues)
<a name="dns_dyn" />
@ -853,7 +851,7 @@ Follow these instructions to get the token for your domain https://tech.yandex.c
Sometimes cloudflare / google doesn't pick new dns records fast enough. You can add `--dnssleep XXX` to params as workaround.
For issues, please report to https://github.com/non7top/acme.sh/issues.
Report any bugs or issues [here](https://github.com/non7top/acme.sh/issues)
<a name="dns_he" />
@ -875,24 +873,11 @@ Then you can issue your certificate:
The `HE_Username` and `HE_Password` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
Please report any issues to https://github.com/angel333/acme.sh or to <me@ondrejsimek.com>.
Report any bugs or issues [here](https://github.com/angel333/acme.sh) or to <me@ondrejsimek.com>.
## 32. Use UnoEuro API to automatically issue cert
**UPD** The UnoEuro is now Simple.com
First you need to login to your UnoEuro account to get your API key.
```sh
export UNO_Key="<key>"
export UNO_User="UExxxxxx"
```
Ok, let's issue a cert now:
```sh
./acme.sh --issue --dns dns_unoeuro -d example.com -d www.example.com
```
The `UNO_Key` and `UNO_User` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
**UPD** The UnoEuro is now [Simply.com](https://github.com/acmesh-official/acme.sh/wiki/dnsapi2#dns_simply)
<a name="dns_inwx" />
@ -922,6 +907,9 @@ export INWX_Shared_Secret="<shared secret>"
You may need to re-enable the mobile tan to gain the shared secret.
<a name="dns_servercow" />
## 34. User Servercow API v1
Create a new user from the Servercow control center. Don't forget to activate **DNS API** for this user.
@ -1019,7 +1007,6 @@ First you need to login to your account to get your API key from: https://my.sel
```sh
export SL_Key="<key>"
```
Ok, let's issue a cert now:
@ -1060,23 +1047,21 @@ The `ZM_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when
## 40. Use DreamHost DNS API
DNS API keys may be created at https://panel.dreamhost.com/?tree=home.api.
Ensure the created key has add and remove privelages.
Ensure the created key has `add` and `remove` privileges.
```sh
export DH_API_KEY="<api key>"
./acme.sh --issue --dns dns_dreamhost -d example.com -d www.example.com
```
The 'DH_API_KEY' will be saved in `~/.acme.sh/account.conf` and will
be reused when needed.
The `DH_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_da" />
## 41. Use DirectAdmin API
The DirectAdmin interface has its own Let's encrypt functionality, but this
script can be used to generate certificates for names which are not hosted on
DirectAdmin
script can be used to generate certificates for names which are not hosted on DirectAdmin.
User must provide login data and URL to the DirectAdmin incl. port.
You can create a user which only has access to
@ -1133,6 +1118,7 @@ Ok, let's issue a cert now:
The `Zilore_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_loopia" />
## 44. Use Loopia API
@ -1169,8 +1155,7 @@ And to issue a cert run:
./acme.sh --issue --dns dns_loopia -d example.com -d *.example.com
```
The exported variables will be saved in `~/.acme.sh/account.conf` and
will be reused when needed.
The exported variables will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_acmedns" />
@ -1193,8 +1178,11 @@ https://github.com/joohoi/acme-dns
./acme.sh --issue --dns dns_acmedns -d example.com -d www.example.com
```
The credentials will be saved in `~/.acme.sh/account.conf` and will
be reused when needed.
The credentials will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_tele3" />
## 46. Use TELE3 API
First you need to login to your TELE3 account to set your API-KEY.
@ -1207,7 +1195,7 @@ export TELE3_Secret="<secret>"
./acme.sh --issue --dns dns_tele3 -d example.com -d *.example.com
```
The TELE3_Key and TELE3_Secret will be saved in ~/.acme.sh/account.conf and will be reused when needed.
The TELE3_Key and TELE3_Secret will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_euserv" />
@ -1217,7 +1205,7 @@ The TELE3_Key and TELE3_Secret will be saved in ~/.acme.sh/account.conf and will
First you need to login to your euserv.eu account and activate your API Administration (API Verwaltung).
[https://support.euserv.com](https://support.euserv.com)
Once you've activate, login to your API Admin Interface and create an API account.
Once you've activated, login to your API Admin Interface and create an API account.
Please specify the scope (active groups: domain) and assign the allowed IPs.
```sh
@ -1232,10 +1220,10 @@ Ok, let's issue a cert now: (Be aware to use the `--insecure` flag, cause euserv
The `EUSERV_Username` and `EUSERV_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
Please report any issues to https://github.com/initit/acme.sh or to <github@initit.de>
Report any bugs or issues [here](https://github.com/initit/acme.sh) or to <github@initit.de>
<a name="dns_gcloud" />
<a name="dns_dpi" />
## 48. Use DNSPod.com domain API to automatically issue cert
@ -1253,6 +1241,9 @@ Ok, let's issue a cert now:
The `DPI_Id` and `DPI_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_gcloud" />
## 49. Use Google Cloud DNS API to automatically issue cert
First you need to authenticate to gcloud.
@ -1272,10 +1263,10 @@ export CLOUDSDK_ACTIVE_CONFIG_NAME=default # see the note above
./acme.sh --issue --dns dns_gcloud -d example.com -d '*.example.com'
```
`dns_gcloud` also supports [DNS alias mode](https://github.com/Neilpang/acme.sh/wiki/DNS-alias-mode).
`dns_gcloud` also supports [DNS alias mode](https://github.com/acmesh-official/acme.sh/wiki/DNS-alias-mode).
<a name="dns_netcup" />
<a name="dns_conoha" />
## 50. Use ConoHa API
@ -1295,6 +1286,9 @@ To issue a cert:
The `CONOHA_Username`, `CONOHA_Password`, `CONOHA_TenantId` and `CONOHA_IdentityServiceApi` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_netcup" />
## 51. Use netcup DNS API to automatically issue cert
First you need to login in your CCP account to get your API Key and API Password.
@ -1311,19 +1305,20 @@ Now, let's issue a cert:
The `NC_Apikey`,`NC_Apipw` and `NC_CID` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
## 52. Use GratisDNS.dk
Removed
https://github.com/acmesh-official/acme.sh/pull/4049
[Removed](https://github.com/acmesh-official/acme.sh/pull/4049)
<a name="dns_namecheap" />
## 53. Use Namecheap
You will need your namecheap username, API KEY (https://www.namecheap.com/support/api/intro.aspx) and your external IP address (or a URL to get it), this IP will need to be whitelisted at Namecheap.
Due to Namecheap's API limitation all the records of your domain will be read and re applied, make sure to have a backup of your records you could apply if any issue would arise.
You will need your namecheap username, API KEY (https://www.namecheap.com/support/api/intro.aspx) and your
external IP address (or a URL to get it), this IP will need to be whitelisted at Namecheap.
Due to Namecheap's API limitation all the records of your domain will be read and re applied,
make sure to have a backup of your records you could apply if any issue would arise.
```sh
export NAMECHEAP_USERNAME="..."
@ -1331,7 +1326,7 @@ export NAMECHEAP_API_KEY="..."
export NAMECHEAP_SOURCEIP="..."
```
NAMECHEAP_SOURCEIP can either be an IP address or a URL to provide it (e.g. https://ifconfig.co/ip).
The `NAMECHEAP_SOURCEIP` can either be an IP address or a URL to provide it (e.g. https://ifconfig.co/ip).
The username and password will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
@ -1341,7 +1336,7 @@ Now you can issue a certificate.
./acme.sh --issue --dns dns_namecheap -d example.com -d *.example.com
```
If you find any bugs of namecheap dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2107
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2107)
<a name="dns_mydnsjp" />
@ -1504,7 +1499,7 @@ Finally, we'll issue the certificate: (Nexcess DNS publishes at max every 15 min
The `NW_API_TOKEN` and `NW_API_ENDPOINT` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
If you find any bugs of Nexcess dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2088
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2088)
<a name="dns_nw" />
@ -1550,6 +1545,9 @@ Finally, we'll issue the certificate: (Futurehosting DNS publishes at max every
The `NW_API_TOKEN` and `NW_API_ENDPOINT` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_rackspace" />
## 64. Use Rackspace API
Set username and API key, which is available under "My Profile & Settings"
@ -1565,14 +1563,14 @@ Now, let's issue a cert:
./acme.sh --issue --dns dns_rackspace -d example.com -d www.example.com
```
If you find any bugs of Rackspace dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2091
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2091)
<a name="dns_online" />
## 65. Use Online API
First, you'll need to retrive your API key, which is available under https://console.online.net/en/api/access
First, you'll need to retrieve your online.net API key, which is available under https://console.online.net/en/api/access
```sh
export ONLINE_API_KEY='<key>'
@ -1586,7 +1584,7 @@ To issue a cert run:
`ONLINE_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
If you find any bugs of online.net dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2093
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2093)
<a name="dns_mydevil" />
@ -1599,9 +1597,11 @@ Make sure that you can execute own binaries:
devil binexec on
```
Install acme.sh, or simply `git clone` it into some directory on your MyDevil host account (in which case you should link to it from your `~/bin` directory).
Install acme.sh, or simply `git clone` it into some directory on your MyDevil host account
(in which case you should link to it from your `~/bin` directory).
If you're not using private IP and depend on default IP provided by host, you may want to edit `crontab` too, and make sure that `acme.sh --cron` is run also after reboot (you can find out how to do that on their wiki pages).
If you're not using private IP and depend on default IP provided by host, you may want to edit `crontab` too,
and make sure that `acme.sh --cron` is run also after reboot (you can find out how to do that on their wiki pages).
To issue a new certificate, run:
@ -1609,14 +1609,14 @@ To issue a new certificate, run:
./acme.sh --issue --dns dns_mydevil -d example.com -d *.example.com
```
After certificate is ready, you can install it with [deploy command](https://github.com/Neilpang/acme.sh/wiki/deployhooks#14-deploy-your-cert-on-mydevilnet).
After certificate is ready, you can install it with [deploy command](https://github.com/acmesh-official/acme.sh/wiki/deployhooks#14-deploy-your-cert-on-mydevilnet).
<a name="dns_cn" />
## 67. Use Core-Networks API to automatically issue cert
First you need to login to your Core-Networks account to set up an API-User.
First you need to login to your Core-Networks.de account to set up an API-User.
Then export username and password to use these credentials.
```sh
@ -1631,7 +1631,10 @@ Ok, let's issue a cert now:
The `CN_User` and `CN_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
If you find any bugs of core-networks.de dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2142
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2142)
<a name="dns_nederhost" />
## 68. Use NederHost API
@ -1647,11 +1650,14 @@ To issue a certificate run:
./acme.sh --issue --dns dns_nederhost -d example.com -d *.example.com
```
If you find any bugs of NederHost dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2089
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2089)
<a name="dns_zone" />
## 69. Use Zone.ee DNS API
First, you'll need to retrive your API key. Estonian insructions https://help.zone.eu/kb/zoneid-api-v2/
First, you'll need to retrieve your API key. Estonian instructions https://help.zone.eu/kb/zoneid-api-v2/
```sh
export ZONE_Username=yourusername
@ -1667,7 +1673,7 @@ To issue a cert run:
`ZONE_Username` and `ZONE_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
If you find any bugs of zone.eu (zone.ee) dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2146
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2146)
<a name="dns_ultra" />
@ -1693,15 +1699,18 @@ To issue a cert run:
./acme.sh --issue --dns dns_ultra -d example.com -d www.example.com
```
`ULTRA_USR` and `ULTRA_PWD` will be saved in `~/.acme.sh/account.conf` and will be resued when needed.
`ULTRA_USR` and `ULTRA_PWD` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
<a name="dns_desec" />
## 71. Use deSEC.io
Sign up for dynDNS at https://desec.io first.
Sign up for deSEC.io dynDNS at https://desec.io first.
Set your API token (password) by generating one from your account on desec.io.
It's also a good idea to restrict the IPv4 / IPv6 address(es) it can be used from.
Set your API token (password) by generating one from your account on desec.io (it's also a good idea to restrict the IPv4 / IPv6 address(es) it can be used from).
```sh
export DEDYN_TOKEN="<token>"
```
@ -1710,7 +1719,7 @@ To issue a certificate run:
./acme.sh --issue --dns dns_desec -d foobar.dedyn.io -d *.foobar.dedyn.io
```
If you find any bugs of deSEC.io API, please report here: https://github.com/Neilpang/acme.sh/issues/2180
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2180)
<a name="dns_openprovider" />
@ -1728,15 +1737,18 @@ export OPENPROVIDER_PASSWORDHASH="<hash>"
`OPENPROVIDER_USER` and `OPENPROVIDER_PASSWORDHASH` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
If you find any bugs of OpenProvider dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2104
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2104)
<a name="dns_maradns" />
## 73. Use MaraDNS API
Make sure you've configured MaraDNS properly and setup a zone file for your domain. See [`csv2(5)`](https://manpages.debian.org/stretch/maradns/csv2.5.en.html).
Make sure you've configured MaraDNS properly and set up a zone file for your domain.
See [`csv2(5)`](https://manpages.debian.org/stretch/maradns/csv2.5.en.html).
Set the path to your zone file, and path to duende's pid file (see, [`duende(8)`](https://manpages.debian.org/stretch/duende/duende.8.en.html) or `ps -C duende o pid,cmd`).
Set the path to your zone file, and path to duende's pid file.
See, [`duende(8)`](https://manpages.debian.org/stretch/duende/duende.8.en.html) or `ps -C duende o pid,cmd`).
The pid file is used to ask duende to reload the configuration automatically after DNS records are added.
```sh
export MARA_ZONE_FILE="/etc/maradns/db.domain.com"
@ -1753,7 +1765,8 @@ Issuing a certificate:
`MARA_ZONE_FILE` and `MARA_DUENDE_PID_PATH` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
If you find any bugs of MaraDNS DNS API, please report here: https://github.com/Neilpang/acme.sh/issues/2072
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2072)
<a name="dns_hetzner" />
@ -1762,12 +1775,13 @@ If you find any bugs of MaraDNS DNS API, please report here: https://github.com/
Get the API Token:
Use [dnsConsole](https://dns.hetzner.com/) to create your hetzner api token.
Issuing a certificate (using letsencrypt):
Issuing a certificate (using LetsEncrypt):
```sh
export HETZNER_Token="<token>"
./acme.sh --issue --dns dns_hetzner -d example.com -d www.example.com --server letsencrypt
```
<a name="dns_ddnss" />
## 75. Use DDNSS.de API
@ -1787,7 +1801,8 @@ After that you can issue a new certificate:
./acme.sh --issue --dns dns_ddnss -d example.com
```
If you find any bugs of ddnss.de API, please report here: https://github.com/Neilpang/acme.sh/issues/2230
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2230)
<a name="dns_nsd" />
@ -1812,9 +1827,9 @@ To issue a new certificate, run:
./acme.sh --issue --dns dns_nsd -d example.com -d *.example.com
```
If you find any bugs of NLnetLabs NSD dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2245
Report any bugs or issues [here](https://github.com/acmesh-official/acme.sh/issues/2245)
-----------------------------------
**[More APIs see here...](https://github.com/Neilpang/acme.sh/wiki/dnsapi2)**
**[More APIs see here...](https://github.com/acmesh-official/acme.sh/wiki/dnsapi2)**