You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1375 lines
39 KiB

9 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
7 years ago
8 years ago
  1. # How to use DNS API
  2. If your dns provider doesn't provide api access, you can use our dns alias mode:
  3. https://github.com/Neilpang/acme.sh/wiki/DNS-alias-mode
  4. ## 1. Use CloudFlare domain API to automatically issue cert
  5. First you need to login to your CloudFlare account to get your [API key](https://dash.cloudflare.com/profile).
  6. ```
  7. export CF_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  8. export CF_Email="xxxx@sss.com"
  9. ```
  10. Ok, let's issue a cert now:
  11. ```
  12. acme.sh --issue --dns dns_cf -d example.com -d www.example.com
  13. ```
  14. The `CF_Key` and `CF_Email` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  15. ## 2. Use DNSPod.cn domain API to automatically issue cert
  16. First you need to login to your DNSPod account to get your API Key and ID.
  17. ```
  18. export DP_Id="1234"
  19. export DP_Key="sADDsdasdgdsf"
  20. ```
  21. Ok, let's issue a cert now:
  22. ```
  23. acme.sh --issue --dns dns_dp -d example.com -d www.example.com
  24. ```
  25. The `DP_Id` and `DP_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  26. ## 3. Use CloudXNS.com domain API to automatically issue cert
  27. First you need to login to your CloudXNS account to get your API Key and Secret.
  28. ```
  29. export CX_Key="1234"
  30. export CX_Secret="sADDsdasdgdsf"
  31. ```
  32. Ok, let's issue a cert now:
  33. ```
  34. acme.sh --issue --dns dns_cx -d example.com -d www.example.com
  35. ```
  36. The `CX_Key` and `CX_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  37. ## 4. Use GoDaddy.com domain API to automatically issue cert
  38. First you need to login to your GoDaddy account to get your API Key and Secret.
  39. https://developer.godaddy.com/keys/
  40. Please create a Production key, instead of a Test key.
  41. ```
  42. export GD_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  43. export GD_Secret="asdfsdafdsfdsfdsfdsfdsafd"
  44. ```
  45. Ok, let's issue a cert now:
  46. ```
  47. acme.sh --issue --dns dns_gd -d example.com -d www.example.com
  48. ```
  49. The `GD_Key` and `GD_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  50. ## 5. Use PowerDNS embedded API to automatically issue cert
  51. First you need to login to your PowerDNS account to enable the API and set your API-Token in the configuration.
  52. https://doc.powerdns.com/md/httpapi/README/
  53. ```
  54. export PDNS_Url="http://ns.example.com:8081"
  55. export PDNS_ServerId="localhost"
  56. export PDNS_Token="0123456789ABCDEF"
  57. export PDNS_Ttl=60
  58. ```
  59. Ok, let's issue a cert now:
  60. ```
  61. acme.sh --issue --dns dns_pdns -d example.com -d www.example.com
  62. ```
  63. The `PDNS_Url`, `PDNS_ServerId`, `PDNS_Token` and `PDNS_Ttl` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  64. ## 6. Use OVH/kimsufi/soyoustart/runabove API to automatically issue cert
  65. https://github.com/Neilpang/acme.sh/wiki/How-to-use-OVH-domain-api
  66. ## 7. Use nsupdate to automatically issue cert
  67. First, generate a key for updating the zone
  68. ```
  69. b=$(dnssec-keygen -a hmac-sha512 -b 512 -n USER -K /tmp foo)
  70. cat > /etc/named/keys/update.key <<EOF
  71. key "update" {
  72. algorithm hmac-sha512;
  73. secret "$(awk '/^Key/{print $2}' /tmp/$b.private)";
  74. };
  75. EOF
  76. rm -f /tmp/$b.{private,key}
  77. ```
  78. Include this key in your named configuration
  79. ```
  80. include "/etc/named/keys/update.key";
  81. ```
  82. Next, configure your zone to allow dynamic updates.
  83. Depending on your named version, use either
  84. ```
  85. zone "example.com" {
  86. type master;
  87. allow-update { key "update"; };
  88. };
  89. ```
  90. or
  91. ```
  92. zone "example.com" {
  93. type master;
  94. update-policy {
  95. grant update subdomain example.com.;
  96. };
  97. }
  98. ```
  99. Finally, make the DNS server and update Key available to `acme.sh`
  100. ```
  101. export NSUPDATE_SERVER="dns.example.com"
  102. export NSUPDATE_KEY="/path/to/your/nsupdate.key"
  103. ```
  104. and optionally (depending on DNS server)
  105. ```
  106. export NSUPDATE_ZONE="example.com"
  107. ```
  108. Ok, let's issue a cert now:
  109. ```
  110. acme.sh --issue --dns dns_nsupdate -d example.com -d www.example.com
  111. ```
  112. The `NSUPDATE_SERVER`, `NSUPDATE_KEY`, and `NSUPDATE_ZONE` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  113. ## 8. Use LuaDNS domain API
  114. Get your API token at https://api.luadns.com/settings
  115. ```
  116. export LUA_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  117. export LUA_Email="xxxx@sss.com"
  118. ```
  119. To issue a cert:
  120. ```
  121. acme.sh --issue --dns dns_lua -d example.com -d www.example.com
  122. ```
  123. The `LUA_Key` and `LUA_Email` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  124. ## 9. Use DNSMadeEasy domain API
  125. Get your API credentials at https://cp.dnsmadeeasy.com/account/info
  126. ```
  127. export ME_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  128. export ME_Secret="qdfqsdfkjdskfj"
  129. ```
  130. To issue a cert:
  131. ```
  132. acme.sh --issue --dns dns_me -d example.com -d www.example.com
  133. ```
  134. The `ME_Key` and `ME_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  135. ## 10. Use Amazon Route53 domain API
  136. https://github.com/Neilpang/acme.sh/wiki/How-to-use-Amazon-Route53-API
  137. ```
  138. export AWS_ACCESS_KEY_ID=XXXXXXXXXX
  139. export AWS_SECRET_ACCESS_KEY=XXXXXXXXXXXXXXX
  140. ```
  141. To issue a cert:
  142. ```
  143. acme.sh --issue --dns dns_aws -d example.com -d www.example.com
  144. ```
  145. The `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  146. ## 11. Use Aliyun domain API to automatically issue cert
  147. First you need to login to your Aliyun account to get your API key.
  148. [https://ak-console.aliyun.com/#/accesskey](https://ak-console.aliyun.com/#/accesskey)
  149. ```
  150. export Ali_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  151. export Ali_Secret="jlsdflanljkljlfdsaklkjflsa"
  152. ```
  153. Ok, let's issue a cert now:
  154. ```
  155. acme.sh --issue --dns dns_ali -d example.com -d www.example.com
  156. ```
  157. The `Ali_Key` and `Ali_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  158. ## 12. Use ISPConfig 3.1 API
  159. This only works for ISPConfig 3.1 (and newer).
  160. Create a Remote User in the ISPConfig Control Panel. The Remote User must have access to at least `DNS zone functions` and `DNS txt functions`.
  161. ```
  162. export ISPC_User="xxx"
  163. export ISPC_Password="xxx"
  164. export ISPC_Api="https://ispc.domain.tld:8080/remote/json.php"
  165. export ISPC_Api_Insecure=1
  166. ```
  167. If you have installed ISPConfig on a different port, then alter the 8080 accordingly.
  168. Leaver ISPC_Api_Insecure set to 1 if you have not a valid ssl cert for your installation. Change it to 0 if you have a valid ssl cert.
  169. To issue a cert:
  170. ```
  171. acme.sh --issue --dns dns_ispconfig -d example.com -d www.example.com
  172. ```
  173. The `ISPC_User`, `ISPC_Password`, `ISPC_Api`and `ISPC_Api_Insecure` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  174. ## 13. Use Alwaysdata domain API
  175. First you need to login to your Alwaysdata account to get your API Key.
  176. ```sh
  177. export AD_API_KEY="myalwaysdataapikey"
  178. ```
  179. Ok, let's issue a cert now:
  180. ```sh
  181. acme.sh --issue --dns dns_ad -d example.com -d www.example.com
  182. ```
  183. The `AD_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused
  184. when needed.
  185. ## 14. Use Linode domain API
  186. The tokens created in the classic manager and cloud manager are incompatible
  187. with one another. While the classic manager makes an all or nothing API, the
  188. newer cloud manager interface promises to produce API keys with a finer
  189. permission system. However, either way works just fine.
  190. ### Classic Manager ###
  191. Classic Manager: https://manager.linode.com/profile/api
  192. First you need to login to your Linode account to get your API Key.
  193. Then add an API key with label *ACME* and copy the new key into the following
  194. command.
  195. ```sh
  196. export LINODE_API_KEY="..."
  197. ```
  198. Due to the reload time of any changes in the DNS records, we have to use the
  199. `dnssleep` option to wait at least 15 minutes for the changes to take effect.
  200. Ok, let's issue a cert now:
  201. ```sh
  202. acme.sh --issue --dns dns_linode --dnssleep 900 -d example.com -d www.example.com
  203. ```
  204. The `LINODE_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be
  205. reused when needed.
  206. ### Cloud Manager ###
  207. Cloud Manager: https://cloud.linode.com/profile/tokens
  208. First you need to login to your Linode account to get your API Key.
  209. 1. Click on "Add a Personal Access Token".
  210. 2. Give the new key a "Label" (we recommend *ACME*)
  211. 3. Give it Read/Write access to "Domains"
  212. 4. "Submit" and copy the new key into the `LINODE_V4_API_KEY` command below.
  213. ```sh
  214. export LINODE_V4_API_KEY="..."
  215. ```
  216. Due to the reload time of any changes in the DNS records, we have to use the
  217. `dnssleep` option to wait at least 15 minutes for the changes to take effect.
  218. Ok, let's issue a cert now:
  219. ```sh
  220. acme.sh --issue --dns dns_linode_v4 --dnssleep 900 -d example.com -d www.example.com
  221. ```
  222. The `LINODE_V4_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be
  223. reused when needed.
  224. ## 15. Use FreeDNS
  225. FreeDNS (https://freedns.afraid.org/) does not provide an API to update DNS records (other than IPv4 and IPv6
  226. dynamic DNS addresses). The acme.sh plugin therefore retrieves and updates domain TXT records by logging
  227. into the FreeDNS website to read the HTML and posting updates as HTTP. The plugin needs to know your
  228. userid and password for the FreeDNS website.
  229. ```sh
  230. export FREEDNS_User="..."
  231. export FREEDNS_Password="..."
  232. ```
  233. You need only provide this the first time you run the acme.sh client with FreeDNS validation and then again
  234. whenever you change your password at the FreeDNS site. The acme.sh FreeDNS plugin does not store your userid
  235. or password but rather saves an authentication token returned by FreeDNS in `~/.acme.sh/account.conf` and
  236. reuses that when needed.
  237. Now you can issue a certificate.
  238. ```sh
  239. acme.sh --issue --dns dns_freedns -d example.com -d www.example.com
  240. ```
  241. Note that you cannot use acme.sh automatic DNS validation for FreeDNS public domains or for a subdomain that
  242. you create under a FreeDNS public domain. You must own the top level domain in order to automatically
  243. validate with acme.sh at FreeDNS.
  244. ## 16. Use cyon.ch
  245. You only need to set your cyon.ch login credentials.
  246. If you also have 2 Factor Authentication (OTP) enabled, you need to set your secret token too and have `oathtool` installed.
  247. ```
  248. export CY_Username="your_cyon_username"
  249. export CY_Password="your_cyon_password"
  250. export CY_OTP_Secret="your_otp_secret" # Only required if using 2FA
  251. ```
  252. To issue a cert:
  253. ```
  254. acme.sh --issue --dns dns_cyon -d example.com -d www.example.com
  255. ```
  256. The `CY_Username`, `CY_Password` and `CY_OTP_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  257. ## 17. Use Domain-Offensive/Resellerinterface/Domainrobot API
  258. ATTENTION: You need to be a registered Reseller to be able to use the ResellerInterface. As a normal user you can not use this method.
  259. You will need your login credentials (Partner ID+Password) to the Resellerinterface, and export them before you run `acme.sh`:
  260. ```
  261. export DO_PID="KD-1234567"
  262. export DO_PW="cdfkjl3n2"
  263. ```
  264. Ok, let's issue a cert now:
  265. ```
  266. acme.sh --issue --dns dns_do -d example.com -d www.example.com
  267. ```
  268. ## 18. Use Gandi LiveDNS API
  269. You must enable the new Gandi LiveDNS API first and the create your api key, See: http://doc.livedns.gandi.net/
  270. ```
  271. export GANDI_LIVEDNS_KEY="fdmlfsdklmfdkmqsdfk"
  272. ```
  273. Ok, let's issue a cert now:
  274. ```
  275. acme.sh --issue --dns dns_gandi_livedns -d example.com -d www.example.com
  276. ```
  277. ## 19. Use Knot (knsupdate) DNS API to automatically issue cert
  278. First, generate a TSIG key for updating the zone.
  279. ```
  280. keymgr tsig generate -t acme_key hmac-sha512 > /etc/knot/acme.key
  281. ```
  282. Include this key in your knot configuration file.
  283. ```
  284. include: /etc/knot/acme.key
  285. ```
  286. Next, configure your zone to allow dynamic updates.
  287. 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/).
  288. ```
  289. acl:
  290. - id: acme_acl
  291. address: 192.168.1.0/24
  292. key: acme_key
  293. action: update
  294. zone:
  295. - domain: example.com
  296. file: example.com.zone
  297. acl: acme_acl
  298. ```
  299. Finally, make the DNS server and TSIG Key available to `acme.sh`
  300. ```
  301. export KNOT_SERVER="dns.example.com"
  302. export KNOT_KEY=`grep \# /etc/knot/acme.key | cut -d' ' -f2`
  303. ```
  304. Ok, let's issue a cert now:
  305. ```
  306. acme.sh --issue --dns dns_knot -d example.com -d www.example.com
  307. ```
  308. The `KNOT_SERVER` and `KNOT_KEY` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  309. ## 20. Use DigitalOcean API (native)
  310. You need to obtain a read and write capable API key from your DigitalOcean account. See: https://www.digitalocean.com/help/api/
  311. ```
  312. export DO_API_KEY="75310dc4ca779ac39a19f6355db573b49ce92ae126553ebd61ac3a3ae34834cc"
  313. ```
  314. Ok, let's issue a cert now:
  315. ```
  316. acme.sh --issue --dns dns_dgon -d example.com -d www.example.com
  317. ```
  318. ## 21. Use ClouDNS.net API
  319. 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.
  320. ```
  321. # Use this for a sub auth ID
  322. export CLOUDNS_SUB_AUTH_ID=XXXXX
  323. # Use this for a regular auth ID
  324. #export CLOUDNS_AUTH_ID=XXXXX
  325. export CLOUDNS_AUTH_PASSWORD="YYYYYYYYY"
  326. ```
  327. Ok, let's issue a cert now:
  328. ```
  329. acme.sh --issue --dns dns_cloudns -d example.com -d www.example.com
  330. ```
  331. The `CLOUDNS_AUTH_ID` and `CLOUDNS_AUTH_PASSWORD` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  332. ## 22. Use Infoblox API
  333. First you need to create/obtain API credentials on your Infoblox appliance.
  334. ```
  335. export Infoblox_Creds="username:password"
  336. export Infoblox_Server="ip or fqdn of infoblox appliance"
  337. ```
  338. Ok, let's issue a cert now:
  339. ```
  340. acme.sh --issue --dns dns_infoblox -d example.com -d www.example.com
  341. ```
  342. Note: This script will automatically create and delete the ephemeral txt record.
  343. The `Infoblox_Creds` and `Infoblox_Server` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  344. ## 23. Use VSCALE API
  345. First you need to create/obtain API tokens on your [settings panel](https://vscale.io/panel/settings/tokens/).
  346. ```
  347. export VSCALE_API_KEY="sdfsdfsdfljlbjkljlkjsdfoiwje"
  348. ```
  349. Ok, let's issue a cert now:
  350. ```
  351. acme.sh --issue --dns dns_vscale -d example.com -d www.example.com
  352. ```
  353. ## 24. Use Dynu API
  354. First you need to create/obtain API credentials from your Dynu account. See: https://www.dynu.com/resources/api/documentation
  355. ```
  356. export Dynu_ClientId="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  357. export Dynu_Secret="yyyyyyyyyyyyyyyyyyyyyyyyy"
  358. ```
  359. Ok, let's issue a cert now:
  360. ```
  361. acme.sh --issue --dns dns_dynu -d example.com -d www.example.com
  362. ```
  363. The `Dynu_ClientId` and `Dynu_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  364. ## 25. Use DNSimple API
  365. First you need to login to your DNSimple account and generate a new oauth token.
  366. https://dnsimple.com/a/{your account id}/account/access_tokens
  367. Note that this is an _account_ token and not a user token. The account token is
  368. needed to infer the `account_id` used in requests. A user token will not be able
  369. to determine the correct account to use.
  370. ```
  371. export DNSimple_OAUTH_TOKEN="sdfsdfsdfljlbjkljlkjsdfoiwje"
  372. ```
  373. To issue the cert just specify the `dns_dnsimple` API.
  374. ```
  375. acme.sh --issue --dns dns_dnsimple -d example.com
  376. ```
  377. The `DNSimple_OAUTH_TOKEN` will be saved in `~/.acme.sh/account.conf` and will
  378. be reused when needed.
  379. If you have any issues with this integration please report them to
  380. https://github.com/pho3nixf1re/acme.sh/issues.
  381. ## 26. Use NS1.com API
  382. ```
  383. export NS1_Key="fdmlfsdklmfdkmqsdfk"
  384. ```
  385. Ok, let's issue a cert now:
  386. ```
  387. acme.sh --issue --dns dns_nsone -d example.com -d www.example.com
  388. ```
  389. ## 27. Use DuckDNS.org API
  390. ```
  391. export DuckDNS_Token="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  392. ```
  393. Please note that since DuckDNS uses StartSSL as their cert provider, thus
  394. --insecure may need to be used when issuing certs:
  395. ```
  396. acme.sh --insecure --issue --dns dns_duckdns -d mydomain.duckdns.org
  397. ```
  398. For issues, please report to https://github.com/raidenii/acme.sh/issues.
  399. ## 28. Use Name.com API
  400. Create your API token here: https://www.name.com/account/settings/api
  401. Note: `Namecom_Username` should be your Name.com username and not the token name. If you accidentally run the script with the token name as the username see `~/.acme.sh/account.conf` to fix the issue
  402. ```
  403. export Namecom_Username="testuser"
  404. export Namecom_Token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  405. ```
  406. And now you can issue certs with:
  407. ```
  408. acme.sh --issue --dns dns_namecom -d example.com -d www.example.com
  409. ```
  410. For issues, please report to https://github.com/raidenii/acme.sh/issues.
  411. ## 29. Use Dyn Managed DNS API to automatically issue cert
  412. First, login to your Dyn Managed DNS account: https://portal.dynect.net/login/
  413. It is recommended to add a new user specific for API access.
  414. The minimum "Zones & Records Permissions" required are:
  415. ```
  416. RecordAdd
  417. RecordUpdate
  418. RecordDelete
  419. RecordGet
  420. ZoneGet
  421. ZoneAddNode
  422. ZoneRemoveNode
  423. ZonePublish
  424. ```
  425. Pass the API user credentials to the environment:
  426. ```
  427. export DYN_Customer="customer"
  428. export DYN_Username="apiuser"
  429. export DYN_Password="secret"
  430. ```
  431. Ok, let's issue a cert now:
  432. ```
  433. acme.sh --issue --dns dns_dyn -d example.com -d www.example.com
  434. ```
  435. The `DYN_Customer`, `DYN_Username` and `DYN_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  436. ## 30. Use pdd.yandex.ru API
  437. ```
  438. export PDD_Token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  439. ```
  440. Follow these instructions to get the token for your domain https://tech.yandex.com/domain/doc/concepts/access-docpage/
  441. ```
  442. acme.sh --issue --dns dns_yandex -d mydomain.example.org
  443. ```
  444. For issues, please report to https://github.com/non7top/acme.sh/issues.
  445. ## 31. Use Hurricane Electric
  446. Hurricane Electric (https://dns.he.net/) doesn't have an API so just set your login credentials like so:
  447. ```
  448. export HE_Username="yourusername"
  449. export HE_Password="password"
  450. ```
  451. Then you can issue your certificate:
  452. ```
  453. acme.sh --issue --dns dns_he -d example.com -d www.example.com
  454. ```
  455. The `HE_Username` and `HE_Password` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  456. Please report any issues to https://github.com/angel333/acme.sh or to <me@ondrejsimek.com>.
  457. ## 32. Use UnoEuro API to automatically issue cert
  458. First you need to login to your UnoEuro account to get your API key.
  459. ```
  460. export UNO_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  461. export UNO_User="UExxxxxx"
  462. ```
  463. Ok, let's issue a cert now:
  464. ```
  465. acme.sh --issue --dns dns_unoeuro -d example.com -d www.example.com
  466. ```
  467. The `UNO_Key` and `UNO_User` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  468. ## 33. Use INWX
  469. [INWX](https://www.inwx.de/) offers an [xmlrpc api](https://www.inwx.de/de/help/apidoc) with your standard login credentials, set them like so:
  470. ```
  471. export INWX_User="yourusername"
  472. export INWX_Password="password"
  473. ```
  474. Then you can issue your certificates with:
  475. ```
  476. acme.sh --issue --dns dns_inwx -d example.com -d www.example.com
  477. ```
  478. The `INWX_User` and `INWX_Password` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  479. If your account is secured by mobile tan you have also defined the shared secret.
  480. ```
  481. export INWX_Shared_Secret="shared secret"
  482. ```
  483. You may need to re-enable the mobile tan to gain the shared secret.
  484. ## 34. User Servercow API v1
  485. Create a new user from the servercow control center. Don't forget to activate **DNS API** for this user.
  486. ```
  487. export SERVERCOW_API_Username=username
  488. export SERVERCOW_API_Password=password
  489. ```
  490. Now you cann issue a cert:
  491. ```
  492. acme.sh --issue --dns dns_servercow -d example.com -d www.example.com
  493. ```
  494. Both, `SERVERCOW_API_Username` and `SERVERCOW_API_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  495. ## 35. Use Namesilo.com API
  496. You'll need to generate an API key at https://www.namesilo.com/account_api.php
  497. Optionally you may restrict the access to an IP range there.
  498. ```
  499. export Namesilo_Key="xxxxxxxxxxxxxxxxxxxxxxxx"
  500. ```
  501. And now you can issue certs with:
  502. ```
  503. acme.sh --issue --dns dns_namesilo --dnssleep 900 -d example.com -d www.example.com
  504. ```
  505. ## 36. Use autoDNS (InternetX)
  506. [InternetX](https://www.internetx.com/) offers an [xml api](https://help.internetx.com/display/API/AutoDNS+XML-API) with your standard login credentials, set them like so:
  507. ```
  508. export AUTODNS_USER="yourusername"
  509. export AUTODNS_PASSWORD="password"
  510. export AUTODNS_CONTEXT="context"
  511. ```
  512. Then you can issue your certificates with:
  513. ```
  514. acme.sh --issue --dns dns_autodns -d example.com -d www.example.com
  515. ```
  516. The `AUTODNS_USER`, `AUTODNS_PASSWORD` and `AUTODNS_CONTEXT` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  517. ## 37. Use Azure DNS
  518. You have to create a service principal first. See:[How to use Azure DNS](../../../wiki/How-to-use-Azure-DNS)
  519. ```
  520. export AZUREDNS_SUBSCRIPTIONID="12345678-9abc-def0-1234-567890abcdef"
  521. export AZUREDNS_TENANTID="11111111-2222-3333-4444-555555555555"
  522. export AZUREDNS_APPID="3b5033b5-7a66-43a5-b3b9-a36b9e7c25ed"
  523. export AZUREDNS_CLIENTSECRET="1b0224ef-34d4-5af9-110f-77f527d561bd"
  524. ```
  525. Then you can issue your certificates with:
  526. ```
  527. acme.sh --issue --dns dns_azure -d example.com -d www.example.com
  528. ```
  529. `AZUREDNS_SUBSCRIPTIONID`, `AZUREDNS_TENANTID`,`AZUREDNS_APPID` and `AZUREDNS_CLIENTSECRET` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  530. ## 38. Use selectel.com(selectel.ru) domain API to automatically issue cert
  531. First you need to login to your account to get your API key from: https://my.selectel.ru/profile/apikeys.
  532. ```sh
  533. export SL_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  534. ```
  535. Ok, let's issue a cert now:
  536. ```
  537. acme.sh --issue --dns dns_selectel -d example.com -d www.example.com
  538. ```
  539. The `SL_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  540. ## 39. Use zonomi.com domain API to automatically issue cert
  541. First you need to login to your account to find your API key from: http://zonomi.com/app/dns/dyndns.jsp
  542. Your will find your api key in the example urls:
  543. ```sh
  544. https://zonomi.com/app/dns/dyndns.jsp?host=example.com&api_key=1063364558943540954358668888888888
  545. ```
  546. ```sh
  547. export ZM_Key="1063364558943540954358668888888888"
  548. ```
  549. Ok, let's issue a cert now:
  550. ```
  551. acme.sh --issue --dns dns_zonomi -d example.com -d www.example.com
  552. ```
  553. The `ZM_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  554. ## 40. Use DreamHost DNS API
  555. DNS API keys may be created at https://panel.dreamhost.com/?tree=home.api.
  556. Ensure the created key has add and remove privelages.
  557. ```
  558. export DH_API_KEY="<api key>"
  559. acme.sh --issue --dns dns_dreamhost -d example.com -d www.example.com
  560. ```
  561. The 'DH_API_KEY' will be saved in `~/.acme.sh/account.conf` and will
  562. be reused when needed.
  563. ## 41. Use DirectAdmin API
  564. The DirectAdmin interface has it's own Let's encrypt functionality, but this
  565. script can be used to generate certificates for names which are not hosted on
  566. DirectAdmin
  567. User must provide login data and URL to the DirectAdmin incl. port.
  568. You can create an user which only has access to
  569. - CMD_API_DNS_CONTROL
  570. - CMD_API_SHOW_DOMAINS
  571. By using the Login Keys function.
  572. See also https://www.directadmin.com/api.php and https://www.directadmin.com/features.php?id=1298
  573. ```
  574. export DA_Api="https://remoteUser:remotePassword@da.domain.tld:8443"
  575. export DA_Api_Insecure=1
  576. ```
  577. Set `DA_Api_Insecure` to 1 for insecure and 0 for secure -> difference is whether ssl cert is checked for validity (0) or whether it is just accepted (1)
  578. Ok, let's issue a cert now:
  579. ```
  580. acme.sh --issue --dns dns_da -d example.com -d www.example.com
  581. ```
  582. The `DA_Api` and `DA_Api_Insecure` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  583. ## 42. Use KingHost DNS API
  584. API access must be enabled at https://painel.kinghost.com.br/painel.api.php
  585. ```
  586. export KINGHOST_Username="yourusername"
  587. export KINGHOST_Password="yourpassword"
  588. acme.sh --issue --dns dns_kinghost -d example.com -d *.example.com
  589. ```
  590. The `KINGHOST_username` and `KINGHOST_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  591. ## 43. Use Zilore DNS API
  592. First, get your API key at https://my.zilore.com/account/api
  593. ```
  594. export Zilore_Key="5dcad3a2-36cb-50e8-cb92-000002f9"
  595. ```
  596. Ok, let's issue a cert now:
  597. ```
  598. acme.sh --issue --dns dns_zilore -d example.com -d *.example.com
  599. ```
  600. The `Zilore_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  601. ## 44. Use Loopia.se API
  602. User must provide login credentials to the Loopia API.
  603. The user needs the following permissions:
  604. - addSubdomain
  605. - updateZoneRecord
  606. - getDomains
  607. - removeSubdomain
  608. Set the login credentials:
  609. ```
  610. export LOOPIA_User="user@loopiaapi"
  611. export LOOPIA_Password="password"
  612. ```
  613. And to issue a cert:
  614. ```
  615. acme.sh --issue --dns dns_loopia -d example.com -d *.example.com
  616. ```
  617. The username and password will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  618. ## 45. Use ACME DNS API
  619. ACME DNS is a limited DNS server with RESTful HTTP API to handle ACME DNS challenges easily and securely.
  620. https://github.com/joohoi/acme-dns
  621. ```
  622. export ACMEDNS_UPDATE_URL="https://auth.acme-dns.io/update"
  623. export ACMEDNS_USERNAME="<username>"
  624. export ACMEDNS_PASSWORD="<password>"
  625. export ACMEDNS_SUBDOMAIN="<subdomain>"
  626. acme.sh --issue --dns dns_acmedns -d example.com -d www.example.com
  627. ```
  628. The credentials will be saved in `~/.acme.sh/account.conf` and will
  629. be reused when needed.
  630. ## 46. Use TELE3 API
  631. First you need to login to your TELE3 account to set your API-KEY.
  632. https://www.tele3.cz/system-acme-api.html
  633. ```
  634. export TELE3_Key="MS2I4uPPaI..."
  635. export TELE3_Secret="kjhOIHGJKHg"
  636. acme.sh --issue --dns dns_tele3 -d example.com -d *.example.com
  637. ```
  638. The TELE3_Key and TELE3_Secret will be saved in ~/.acme.sh/account.conf and will be reused when needed.
  639. ## 47. Use Euserv.eu API
  640. First you need to login to your euserv.eu account and activate your API Administration (API Verwaltung).
  641. [https://support.euserv.com](https://support.euserv.com)
  642. Once you've activate, login to your API Admin Interface and create an API account.
  643. Please specify the scope (active groups: domain) and assign the allowed IPs.
  644. ```
  645. export EUSERV_Username="99999.user123"
  646. export EUSERV_Password="Asbe54gHde"
  647. ```
  648. Ok, let's issue a cert now: (Be aware to use the `--insecure` flag, cause euserv.eu is still using self-signed certificates!)
  649. ```
  650. acme.sh --issue --dns dns_euserv -d example.com -d *.example.com --insecure
  651. ```
  652. The `EUSERV_Username` and `EUSERV_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  653. Please report any issues to https://github.com/initit/acme.sh or to <github@initit.de>
  654. ## 48. Use DNSPod.com domain API to automatically issue cert
  655. First you need to get your API Key and ID by this [get-the-user-token](https://www.dnspod.com/docs/info.html#get-the-user-token).
  656. ```
  657. export DPI_Id="1234"
  658. export DPI_Key="sADDsdasdgdsf"
  659. ```
  660. Ok, let's issue a cert now:
  661. ```
  662. acme.sh --issue --dns dns_dpi -d example.com -d www.example.com
  663. ```
  664. The `DPI_Id` and `DPI_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  665. ## 49. Use Google Cloud DNS API to automatically issue cert
  666. First you need to authenticate to gcloud.
  667. ```
  668. gcloud init
  669. ```
  670. **The `dns_gcloud` script uses the active gcloud configuration and credentials.**
  671. There is no logic inside `dns_gcloud` to override the project and other settings.
  672. If needed, create additional [gcloud configurations](https://cloud.google.com/sdk/gcloud/reference/topic/configurations).
  673. You can change the configuration being used without *activating* it; simply set the `CLOUDSDK_ACTIVE_CONFIG_NAME` environment variable.
  674. To issue a certificate you can:
  675. ```
  676. export CLOUDSDK_ACTIVE_CONFIG_NAME=default # see the note above
  677. acme.sh --issue --dns dns_gcloud -d example.com -d '*.example.com'
  678. ```
  679. `dns_gcloud` also supports [DNS alias mode](https://github.com/Neilpang/acme.sh/wiki/DNS-alias-mode).
  680. ## 50. Use ConoHa API
  681. First you need to login to your ConoHa account to get your API credentials.
  682. ```
  683. export CONOHA_Username="xxxxxx"
  684. export CONOHA_Password="xxxxxx"
  685. export CONOHA_TenantId="xxxxxx"
  686. export CONOHA_IdentityServiceApi="https://identity.xxxx.conoha.io/v2.0"
  687. ```
  688. To issue a cert:
  689. ```
  690. acme.sh --issue --dns dns_conoha -d example.com -d www.example.com
  691. ```
  692. The `CONOHA_Username`, `CONOHA_Password`, `CONOHA_TenantId` and `CONOHA_IdentityServiceApi` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  693. ## 51. Use netcup DNS API to automatically issue cert
  694. First you need to login in your CCP account to get your API Key and API Password.
  695. ```
  696. export NC_Apikey="<Apikey>"
  697. export NC_Apipw="<Apipassword>"
  698. export NC_CID="<Customernumber>"
  699. ```
  700. Now, let's issue a cert:
  701. ```
  702. acme.sh --issue --dns dns_netcup -d example.com -d www.example.com
  703. ```
  704. The `NC_Apikey`,`NC_Apipw` and `NC_CID` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  705. ## 52. Use GratisDNS.dk
  706. GratisDNS.dk (https://gratisdns.dk/) does not provide an API to update DNS records (other than IPv4 and IPv6
  707. dynamic DNS addresses). The acme.sh plugin therefore retrieves and updates domain TXT records by logging
  708. into the GratisDNS website to read the HTML and posting updates as HTTP. The plugin needs to know your
  709. userid and password for the GratisDNS website.
  710. ```sh
  711. export GDNSDK_Username="..."
  712. export GDNSDK_Password="..."
  713. ```
  714. The username and password will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  715. Now you can issue a certificate.
  716. Note: It usually takes a few minutes (usually 3-4 minutes) before the changes propagates to gratisdns.dk nameservers (ns3.gratisdns.dk often are slow),
  717. and in rare cases I have seen over 5 minutes before google DNS catches it. Therefor a DNS sleep of at least 300 seconds are recommended-
  718. ```sh
  719. acme.sh --issue --dns dns_gdnsdk --dnssleep 300 -d example.com -d *.example.com
  720. ```
  721. ## 53. Use Namecheap
  722. You will need your namecheap username, API KEY (https://www.namecheap.com/support/api/intro.aspx) and your external IP address (or an URL to get it), this IP will need to be whitelisted at Namecheap.
  723. 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.
  724. ```sh
  725. export NAMECHEAP_USERNAME="..."
  726. export NAMECHEAP_API_KEY="..."
  727. export NAMECHEAP_SOURCEIP="..."
  728. ```
  729. NAMECHEAP_SOURCEIP can either be an IP address or an URL to provide it (e.g. https://ifconfig.co/ip).
  730. The username and password will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  731. Now you can issue a certificate.
  732. ```sh
  733. acme.sh --issue --dns dns_namecheap -d example.com -d *.example.com
  734. ```
  735. ## 54. Use MyDNS.JP API
  736. First, register to MyDNS.JP and get MasterID and Password.
  737. ```
  738. export MYDNSJP_MasterID=MasterID
  739. export MYDNSJP_Password=Password
  740. ```
  741. To issue a certificate:
  742. ```
  743. acme.sh --issue --dns dns_mydnsjp -d example.com -d www.example.com
  744. ```
  745. The `MYDNSJP_MasterID` and `MYDNSJP_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  746. ## 55. Use hosting.de API
  747. Create an API key in your hosting.de account here: https://secure.hosting.de
  748. The key needs the following rights:
  749. - DNS_ZONES_EDIT
  750. - DNS_ZONES_LIST
  751. Set your API Key and endpoint:
  752. ```
  753. export HOSTINGDE_APIKEY='xxx'
  754. export HOSTINGDE_ENDPOINT='https://secure.hosting.de'
  755. ```
  756. The plugin can also be used for the http.net API. http.net customers have to set endpoint to https://partner.http.net.
  757. Ok, let's issue a cert now:
  758. ```
  759. acme.sh --issue --dns dns_hostingde -d example.com -d *.example.com
  760. ```
  761. The hosting.de API key and endpoint will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  762. ## 56. Use Neodigit.net API
  763. ```
  764. export NEODIGIT_API_TOKEN="eXJxTkdUVUZmcHQ3QWJackQ4ZGlMejRDSklRYmo5VG5zcFFKK2thYnE0WnVnNnMy"
  765. ```
  766. Ok, let's issue a cert now:
  767. ```
  768. acme.sh --issue --dns dns_neodigit -d example.com -d www.example.com
  769. ```
  770. Neodigit API Token will be saved in `~/.acme.sh/account.conf` and will be used when needed.
  771. ## 57. Use Exoscale API
  772. Create an API key and secret key in the Exoscale account section
  773. Set your API and secret key:
  774. ```
  775. export EXOSCALE_API_KEY='xxx'
  776. export EXOSCALE_SECRET_KEY='xxx'
  777. ```
  778. Now, let's issue a cert:
  779. ```
  780. acme.sh --issue --dns dns_exoscale -d example.com -d www.example.com
  781. ```
  782. The `EXOSCALE_API_KEY` and `EXOSCALE_SECRET_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  783. ## 58. Using PointHQ API to issue certs
  784. Log into [PointHQ account management](https://app.pointhq.com/profile) and copy the API key from the page there.
  785. ```export PointHQ_Key="apikeystringgoeshere"
  786. exportPointHQ_Email="accountemail@yourdomain.com"
  787. ```
  788. You can then issue certs by using:
  789. ```acme.sh --issue --dns dns_pointhq -d example.com -d www.example.com
  790. ```
  791. ## 59. Use Active24 API
  792. Create an API token in the Active24 account section, documentation on https://faq.active24.com/cz/790131-REST-API-rozhran%C3%AD.
  793. Set your API token:
  794. ```
  795. export ACTIVE24_Token='xxx'
  796. ```
  797. Now, let's issue a cert, set `dnssleep` for propagation new DNS record:
  798. ```
  799. acme.sh --issue --dns dns_active24 -d example.com -d www.example.com --dnssleep 1000
  800. ```
  801. The `ACTIVE24_Token` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  802. ## 60. Use do.de API
  803. Create an API token in your do.de account.
  804. Set your API token:
  805. ```
  806. export DO_LETOKEN='FmD408PdqT1E269gUK57'
  807. ```
  808. To issue a certificate run:
  809. ```
  810. acme.sh --issue --dns dns_doapi -d example.com -d *.example.com
  811. ```
  812. The API token will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  813. ## 61. Use Nexcess API
  814. First, you'll need to login to the [Nexcess.net Client Portal](https://portal.nexcess.net) and [generate a new API token](https://portal.nexcess.net/api-token).
  815. Once you have a token, set it in your systems environment:
  816. ```
  817. export NW_API_TOKEN="YOUR_TOKEN_HERE"
  818. export NW_API_ENDPOINT="https://portal.nexcess.net"
  819. ```
  820. Finally, we'll issue the certificate: (Nexcess DNS publishes at max every 15 minutes, we recommend setting a 900 second `--dnssleep`)
  821. ```
  822. acme.sh --issue --dns dns_nw -d example.com --dnssleep 900
  823. ```
  824. The `NW_API_TOKEN` and `NW_API_ENDPOINT` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  825. ## 62. Use Thermo.io API
  826. First, you'll need to login to the [Thermo.io Client Portal](https://core.thermo.io) and [generate a new API token](https://core.thermo.io/api-token).
  827. Once you have a token, set it in your systems environment:
  828. ```
  829. export NW_API_TOKEN="YOUR_TOKEN_HERE"
  830. export NW_API_ENDPOINT="https://core.thermo.io"
  831. ```
  832. Finally, we'll issue the certificate: (Thermo DNS publishes at max every 15 minutes, we recommend setting a 900 second `--dnssleep`)
  833. ```
  834. acme.sh --issue --dns dns_nw -d example.com --dnssleep 900
  835. ```
  836. The `NW_API_TOKEN` and `NW_API_ENDPOINT` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  837. ## 63. Use Futurehosting API
  838. First, you'll need to login to the [Futurehosting Client Portal](https://my.futurehosting.com) and [generate a new API token](https://my.futurehosting.com/api-token).
  839. Once you have a token, set it in your systems environment:
  840. ```
  841. export NW_API_TOKEN="YOUR_TOKEN_HERE"
  842. export NW_API_ENDPOINT="https://my.futurehosting.com"
  843. ```
  844. Finally, we'll issue the certificate: (Futurehosting DNS publishes at max every 15 minutes, we recommend setting a 900 second `--dnssleep`)
  845. ```
  846. acme.sh --issue --dns dns_nw -d example.com --dnssleep 900
  847. ```
  848. The `NW_API_TOKEN` and `NW_API_ENDPOINT` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  849. ## 64. Use Rackspace API
  850. Set username and API key, which is available under "My Profile & Settings"
  851. ```
  852. export RACKSPACE_Username='username'
  853. export RACKSPACE_Apikey='xxx'
  854. ```
  855. Now, let's issue a cert:
  856. ```
  857. acme.sh --issue --dns dns_rackspace -d example.com -d www.example.com
  858. ```
  859. ## 65. Use Online API
  860. First, you'll need to retrive your API key, which is available under https://console.online.net/en/api/access
  861. ```
  862. export ONLINE_API_KEY='xxx'
  863. ```
  864. To issue a cert run:
  865. ```
  866. acme.sh --issue --dns dns_online -d example.com -d www.example.com
  867. ```
  868. `ONLINE_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  869. ## 66. Use MyDevil.net
  870. Make sure that you can execute own binaries:
  871. ```sh
  872. devil binexec on
  873. ```
  874. 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).
  875. 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).
  876. To issue a new certificate, run:
  877. ```sh
  878. acme.sh --issue --dns dns_mydevil -d example.com -d *.example.com
  879. ```
  880. After certificate is ready, you can install it with [deploy command](../deploy/README.md#14-deploy-your-cert-on-mydevilnet).
  881. ## 67. Use Core-Networks API to automatically issue cert
  882. First you need to login to your Core-Networks account to to set up an API-User.
  883. Then export username and password to use these credentials.
  884. ```
  885. export CN_User="user"
  886. export CN_Password="passowrd"
  887. ```
  888. Ok, let's issue a cert now:
  889. ```
  890. acme.sh --issue --dns dns_cn -d example.com -d www.example.com
  891. ```
  892. The `CN_User` and `CN_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  893. ## 68. Use NederHost API
  894. Create an API token in Mijn NederHost.
  895. Set your API key:
  896. ```
  897. export NederHost_Key='xxx'
  898. ```
  899. To issue a certificate run:
  900. ```
  901. acme.sh --issue --dns dns_nederhost -d example.com -d *.example.com
  902. ```
  903. ## 69. Use Zone.ee DNS API
  904. First, you'll need to retrive your API key. Estonian insructions https://help.zone.eu/kb/zoneid-api-v2/
  905. ```
  906. export ZONE_Username=yourusername
  907. export ZONE_Key=keygoeshere
  908. ```
  909. To issue a cert run:
  910. ```
  911. acme.sh --issue -d example.com -d www.example.com --dns dns_zone
  912. ```
  913. `ZONE_Username` and `ZONE_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  914. ## 70. Use UltraDNS API
  915. UltraDNS is a paid for service that provides DNS, as well as Web and Mail forwarding (as well as reporting, auditing, and advanced tools).
  916. More information can be found here: https://www.security.neustar/lp/ultra20/index.html
  917. The REST API documentation for this service is found here: https://portal.ultradns.com/static/docs/REST-API_User_Guide.pdf
  918. Set your UltraDNS User name, and password; these would be the same you would use here:
  919. https://portal.ultradns.com/ - or if you create an API only user, that username and password would be better utilized.
  920. ```
  921. export ULTRA_USR="abcd"
  922. export ULTRA_PWD="efgh"
  923. To issue a cert run:
  924. acme.sh --issue --dns dns_ultra -d example.com -d www.example.com
  925. ```
  926. `ULTRA_USR` and `ULTRA_PWD` will be saved in `~/.acme.sh/account.conf` and will be resued when needed.
  927. # Use custom API
  928. If your API is not supported yet, you can write your own DNS API.
  929. Let's assume you want to name it 'myapi':
  930. 1. Create a bash script named `~/.acme.sh/dns_myapi.sh`,
  931. 2. In the script you must have a function named `dns_myapi_add()` which will be called by acme.sh to add the DNS records.
  932. 3. Then you can use your API to issue cert like this:
  933. ```
  934. acme.sh --issue --dns dns_myapi -d example.com -d www.example.com
  935. ```
  936. For more details, please check our sample script: [dns_myapi.sh](dns_myapi.sh)
  937. See: https://github.com/Neilpang/acme.sh/wiki/DNS-API-Dev-Guide
  938. # Use lexicon DNS API
  939. https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api