From 66511edae5f45951b7bcc7f6f85a396747b46249 Mon Sep 17 00:00:00 2001 From: Marvo2011 Date: Thu, 8 Sep 2022 07:04:14 +0200 Subject: [PATCH] Split dnsapi page because github render error on a too large page --- dnsapi.md | 1588 +---------------------------------------------------- 1 file changed, 2 insertions(+), 1586 deletions(-) diff --git a/dnsapi.md b/dnsapi.md index 93d022f..7253061 100644 --- a/dnsapi.md +++ b/dnsapi.md @@ -1471,1592 +1471,8 @@ To issue a new certificate, run: If you find any bugs of NLnetLabs NSD dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2245 -## 76. Use Schlundtech - -[Schlundtech](https://www.schlundtech.de/) offers an [xml api](https://www.schlundtech.de/services/xml-gateway/) with your standard login credentials, set them like so: - -```sh -export SCHLUNDTECH_USER="yourusername" -export SCHLUNDTECH_PASSWORD="password" -``` - -Then you can issue your certificates with: - -```sh -./acme.sh --issue --dns dns_schlundtech -d example.com -d www.example.com -``` - -The `SCHLUNDTECH_USER` and `SCHLUNDTECH_PASSWORD` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs of Schlundtech.de API, please report here: https://github.com/Neilpang/acme.sh/issues/2246 - -## 77. Use your one.com credentials as you would login into the control panel. - -```sh -export ONECOM_User="sdfsdfsdfljlbjkljlkjsdfoiwje" -export ONECOM_Password="xxxx@sss.com" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_one -d example.com -d www.example.com -``` - -Note: -It's no longer possible to add TXT Records with the Name "_acme-challenge" to the base Domain. -To override the fallback value, you must use a CNAME and proxy it. -For example: -CNAME _acme-challenge.yourdomain.com => proxy_acme-challenge.yourdomain.com -The TXT Records have to be created on proxy_acme-challenge.yourdomain.com -Since the default CNAME TTL is 3600 seconds, it is recommended to leave the CNAME record. -But if you would like to use the build-in SSL (for your Web-Site etc.) from one.com, you have to delete the Record. - -You can set "ONECOM_KeepCnameProxy" to keep the CNAME record. - -```sh -export ONECOM_KeepCnameProxy=1 -``` - -By default the CNAME record will be removed. - -The `ONECOM_User`,`ONECOM_Password` and `ONECOM_KeepCnameProxy` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs of one.com dns API, please report here: https://github.com/Neilpang/acme.sh/issues/2103 - -## 78. Use acmeproxy DNS API - -[Acmeproxy](https://github.com/mdbraber/acmeproxy/) can be used to as a single host in your network to request certificates through a DNS API. Clients can connect with one single host (the acmeproxy) so you don't need to store your DNS API credentials on every single host that wants to request a certificate. - -```sh -export ACMEPROXY_ENDPOINT="https://acmeproxy.yourhost.com:9096" -export ACMEPROXY_USERNAME="username" -export ACMEPROXY_PASSWORD="password" -``` - -Then you can issue your certificates with: - -```sh -./acme.sh --issue --dns dns_acmeproxy -d example.com -d www.example.com -``` - -The `ACMEPROXY_ENDPOINT`, `ACMEPROXY_USERNAME` and `ACMEPROXY_PASSWORD` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs of acmeproxy DNS API, please report here: https://github.com/Neilpang/acme.sh/issues/2251 - -## 79. Use internetbs.net API - -Create an API token in your internetbs.net account. - -Set your API token: -```sh -export INTERNETBS_API_KEY="..." -export INTERNETBS_API_PASSWORD="..." -``` - -To issue a certificate run: -```sh -./acme.sh --issue --dns dns_internetbs -d example.com -d www.example.com -``` - -The `INTERNETBS_API_KEY` and `INTERNETBS_API_PASSWORD` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs of internetbs.net API, please report here: https://github.com/Neilpang/acme.sh/issues/2261 - -## 80. Use durabledns.com API - -Create an API token in your durabledns.com account. - -Set your API token: -```sh -export DD_API_User="..." -export DD_API_Key="..." -``` - -To issue a certificate run: -```sh -./acme.sh --issue --dns dns_durabledns -d example.com -d '*.example.com' -``` - -The `DD_API_User` and `DD_API_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs of durabledns.com API, please report here: https://github.com/Neilpang/acme.sh/issues/2281 - - -## 81. Use reg.ru API - -Set your API credentials: -```sh -export REGRU_API_Username='test' -export REGRU_API_Password='test' -``` - -To issue a certificate run: -```sh -./acme.sh --issue --dns dns_regru -d 'example.com' -d '*.example.com' -``` - -The `REGRU_API_Username` and `REGRU_API_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs of reg.ru API, please report here: [Issue #2336](../issues/2336) - -RU: - -Установите свои учетные данные API: - -В [Настройки API](https://www.reg.ru/user/account/#/settings/api/) для авторизации устанавливаем пароль в настройках "Альтернативный пароль", и добавляем IP в "Диапазоны IP-адресов" для избежание ошибки -``` -response='{ - "charset" : "utf-8", - "error_code" : "ACCESS_DENIED_FROM_IP", - "error_params" : { - "command_name" : "service/get_list" - }, - "error_text" : "Access to API from this IP denied", - "messagestore" : null, - "result" : "error" -}' -``` -Диапазоны IP-адресов -acme-v02.api.letsencrypt.org - `172.65.32.248` для получения SSL и api.reg.ru - `194.58.116.30` для тхт записи _acme-challenge - -Для авторизатции в API выполните: -```sh -export REGRU_API_Username='водим свой логин для входа на REG.RU' -export REGRU_API_Password='водим пароль каторый настроили в настройках API для авторизации' -``` -Для получения сертификата выполните: -```sh -./acme.sh --issue --dns dns_regru -d 'example.com' -d '*.example.com' -``` -Настройки для авторизации `REGRU_API_Username` и `REGRU_API_Password` будут сохранены в `~/.acme.sh/account.conf` и будут использоваться повторно при необходимости из конфига acme. - -Если вы обнаружите какие-либо ошибки в API reg.ru, сообщите об этом здесь: [Issue #2336](../issues/2336) - -## 82. Use Vultr DNS API to automatically issue cert - -You'll need an API key for your Vultr account which you can find [under the Account settings](https://my.vultr.com/settings/#settingsapi) and you'll want to ensure the API key is allowed for any IPs you might be using acme.sh with. - -Vultr supports creating sub-accounts with limited permissions, and it's a good idea to create a sub-account with only the 'Manage DNS' permission and use an API key from that sub-account. - -```sh -export VULTR_API_KEY="" -``` - -To issue a cert: - -```sh -./acme.sh --issue --dns dns_vultr -d example.com -d www.example.com -``` - -The `VULTR_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs of Vultr API, please report here: [Issue #2374](../../issues/2374) - - - -## 83. Use jdcloud.com DNS API to automatically issue cert - -支持京东云 jdcloud.com 的免费dns服务. 请先登陆控制台获取 api key id 和 api key secret: - -https://uc.jdcloud.com/account/accesskey - -```sh -export JD_ACCESS_KEY_ID="sdfsdfsdfljlbjkljlkjsdfoiwje" -export JD_ACCESS_KEY_SECRET="xxxxxxx" -``` - -然后生成证书: - -```sh -./acme.sh --issue --dns dns_jd -d example.com -d www.example.com -``` - -`JD_ACCESS_KEY_ID` 和 `JD_ACCESS_KEY_SECRET` 会自动保存在这里 `~/.acme.sh/account.conf`, 下次再生成证书时, 可以自动重用. - -高级选项: -1. 默认使用的是 `cn-north-1` 区域. 目前不需要改动, 如果需要改的话, 再生成证书之前执行: -```sh -export JD_REGION="cn-north-1" # 这里写你要改的区域 -``` - -有 bug 的话可以报到这里: https://github.com/Neilpang/acme.sh/issues/2388 - - -## 84. Use hexonet.com DNS API to automatically issue a cert - -Create a role user in your Account -> Settings -> ShareAccess - -Set the Access Control like bellow: -``` -QueryDNSZoneRRList(dnszone=*):ALLOW -UpdateDNSZone():ALLOW -``` - -Remember the role id and role password. - -```sh -export Hexonet_Login='username!roleId' -export Hexonet_Password="role password" -``` - -For example: -My user name is `neilpang`, my role id is: `testid`. So I use the following format: - -```sh -export Hexonet_Login='neilpang!testid' -``` - - -To issue a cert: - -```sh -./acme.sh --issue --dns dns_hexonet -d example.com -d www.example.com -``` - -The `Hexonet_Login` and `Hexonet_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs, please report here: - -https://github.com/Neilpang/acme.sh/issues/2389 - - -## 85. Use Domeneshop DNS API to automatically issue a cert - -You'll have to get a Domeneshop API key and secret (https://api.domeneshop.no/docs/). - -```sh -export DOMENESHOP_Token="1234567890" -export DOMENESHOP_Secret="1234567890abcdefghijklmnopqrstuvw" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_domeneshop -d example.com -d www.example.com -``` - -The `DOMENESHOP_Token` and `DOMENESHOP_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs, please report here: - -https://github.com/Neilpang/acme.sh/issues/2457 - - -## 86. Use OPNsense embedded API to automatically issue cert - -First you need to login to your OPNsense account and create an API Key for a user with access to the Bind service. - -https://docs.opnsense.org/development/api.html - -```sh -export OPNs_Host="opnsense.example.com" -export OPNs_Port="443" -export OPNs_Key="qocfU9RSbt8vTIBcnW8bPqCrpfAHMDvj5OzadE7Str+rbjyCyk7u6yMrSCHtBXabgDDXx/dY0POUp7ZA" -export OPNs_Token="pZEQ+3ce8dDlfBBdg3N8EpqpF5I1MhFqdxX06le6Gl8YzyQvYCfCzNaFX9O9+IOSyAs7X71fwdRiZ+Lv" -export OPNs_Api_Insecure=0 -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_opnsense -d example.com -d www.example.com -``` - -The `OPNs_Host`, `OPNs_Port`, `OPNs_Key`, `OPNs_Token` and `OPNs_Api_Insecure` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs, please report here: - -https://github.com/Neilpang/acme.sh/issues/2480 - -## 87. Use the RcodeZero API to automatically issue cert - -First you need to login to your RcodeZero account, enable the REST API and generate an ACME API token (only the ACME API token will work wih acme.sh. It has limited access and could only be used to add/remove challenges to the zones). - -https://my.rcodezero.at/enableapi - -```sh -export RCODE0_API_TOKEN="acme_1232342342343OEH1G1gDcKNMsN7mx9EZgSU6AX79u5KRSxWnC" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_rcode0 -d example.com -d www.example.com -``` - -The `RCODE0_API_TOKEN` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -The RcodeZero API driver supports two addtional environment variables -```sh -export RCODE0_URL=https://my.rcodezero.at -``` -Use a different RcodeZero API Endpoint (e.g. the RcodeZero Testsystem) -```sh -export RCODE0_TTL=60 -``` -Use a different TTL for the generated records - -If you find any bugs, please report here: - -https://github.com/Neilpang/acme.sh/issues/2490 - -## 88. Use MailinaBox - -Use the MailinaBox (MIAB) Custom DNS REST API interface to MIAB DNS. You only need to set your MIAB login credentials and the fully qualified domain name of the MIAB Server. Suggest single quote over double quote to ensure characters are not interpreted by the shell - important for passwords. - -```sh -export MIAB_Username='your_MIAB_admin_username' -export MIAB_Password='your_MIAB_admin_password' -export MIAB_Server='FQDN_of_your_MIAB_Server' -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_miab -d example.com -d www.example.com -``` - -The `MIAB_Username`, `MIAB_Password` and `MIAB_Server` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs, please report here: - -https://github.com/Neilpang/acme.sh/issues/2550 - - - - -## 89. Use nic.ru DNS -You need to login to nic.ru account and register your application [here](https://www.nic.ru/manager/oauth.cgi?step=oauth.app_register). - -You need to define the following environment variables befor issuing a cert: -* `NIC_Username` - login for site `nic.ru` in form `000000/NIC-D` -* `NIC_Password` - password for site `nic.ru`. It may be administrative or technical password ([details](https://www.nic.ru/help/use-of-administrative-and-technical-passwords-according-to-the-agreement_6148.html)) -* `NIC_ClientID` - your application identifier ([details](https://www.nic.ru/help/oauth-server_5809.html)) -* `NIC_ClientSecret` - your application secret -* _`NIC_Token` is base64 encoded string `:`. **This variable is deprecated**. It is used for backward compatibility. If NIC_ClientID and NIC_ClientSecret are not defined, then they are calculated using old NIC_Token variable._ - -```bash -export NIC_Username='000000/NIC-D' -export NIC_Password='xxxxxxxx' -export NIC_ClientID='xxxxxxxx' -export NIC_ClientSecret='xxxxxxxx' -``` - -To issue a cert: -```bash -./acme.sh --issue --dns dns_nic -d domain.com -d www.domain.com -``` -The NIC_Username, NIC_Password, NIC_ClientID and NIC_ClientSecret will be saved in ~/.acme.sh/account.conf and will be reused when needed. - -If you find any bugs, please report here: - -https://github.com/Neilpang/acme.sh/issues/2547 - -Docs: -* https://www.nic.ru/help/upload/file/API_DNS-hosting-en.pdf -* https://www.nic.ru/help/oauth-server_5809.html - -## 90. Use Leaseweb.com domain API to automatically issue cert - -First you need to login to your Leaseweb account to get your API Key. - -```sh -export LSW_Key="safas-3fs3sd-34sdf-safss" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_leaseweb -d example.com -d www.example.com -``` - -The `LSW_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs, please report here: https://github.com/Neilpang/acme.sh/issues/2558 - - -## 91. Use variomedia.de domain API to automatically issue cert - -First you need to obtain your API Key from variomedia's customer support. - -```sh -export VARIOMEDIA_API_TOKEN="sdfsdfsdfljlbjkljlkjsdfoiwjesdfsdfsdfljlbjkljlkjsdfoiwje" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_variomedia -d example.com -d www.example.com -``` - -The `VARIOMEDIA_API_TOKEN` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs, please report here: https://github.com/Neilpang/acme.sh/issues/2564 - - -## 92. Use Plesk XML API to automatically issue cert - -Before using the module, you must set your Plesk user name and password, and the address of your Plesk XML API (sometimes called a URI, URL or web link). The URI usually looks similar to this: - -``` -https://address-of-my-plesk-server.net:8443/enterprise/control/agent.php -``` - -All commands are CASE SENSITIVE: - -```sh -export pleskxml_uri="address of my Plesk server's API" -export pleskxml_user="my plesk username" -export pleskxml_pass="my plesk password" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_pleskxml -d example.com -d www.example.com -``` - -The `pleskxml_uri`, `pleskxml_user` and `pleskxml_pass` will be saved in `~/.acme.sh/account.conf` and reused when needed. - -If you find any bugs, please report here: https://github.com/Neilpang/acme.sh/issues/2577 - -## 93. Use PDNS Manager API - -[PDNS Manager](https://pdnsmanager.org/) is a web frontend for [Power DNS](https://www.powerdns.com/). - -This script uses PDNS Manager API and its "[Update via GET request](https://pdnsmanager.org/documentation/api/)" method. So only single record update possible and no wildcards, for now. - -```sh -export PDNS_MANAGER_URL=https://mypdnsmanagerurl.nx -export PDNS_MANAGER_RECORDID= -export PDNS_MANAGER_PASSWORD= -``` - -* Add your domain to PDNS Manager. -* [Create a password](https://pdnsmanager.org/documentation/api/) for your record. - -Then issue a new certificate: - -```sh -./acme.sh --issue -d example.com --dns dns_pdnsmanager -``` - -## 94. Use Misaka.io domain API - -Get your API token at https://console.misaka.io/settings - -```sh -export Misaka_Key="sdfsdfsdfljlbjkljlkjsdfoiwje" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_misaka -d example.com -d www.example.com -``` - -## 95. Use easyDNS.net API to automatically issue a cert -You need to sign up for API access [here](https://cp.easydns.com/manage/security/api/signup.php) or select 'User' -> 'Security' from the top menu and select 'signup' in the 'easyDNS REST API' section after logging in to your account. -API Docs: https://sandbox.rest.easydns.net:3001/ - -Note that initially you are only granted API access to a sandbox environment, not your live DNS settings. - -```sh -export EASYDNS_Token="xxxxxxxxxxxxxxx.xxxxxxxx" -export EASYDNS_Key="apixxxxxxxxxxxxxx.xxxxxxxx" -``` - - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_easydns -d example.com -d www.example.com -``` -The `EASYDNS_Token` and `EASYDNS_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs, please report here: - -https://github.com/acmesh-official/acme.sh/issues/2647 - -## 96. Use CloudDNS API to automatically issue a cert -Docs: https://github.com/vshosting/clouddns - -```sh -export CLOUDDNS_EMAIL="email@example.com" -export CLOUDDNS_PASSWORD="xxxxxxxx" -export CLOUDDNS_CLIENT_ID="xxxxxxxxxxxxxxxxxxxx" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_clouddns -d example.com -d www.example.com -``` -The `CLOUDDNS_EMAIL`, `CLOUDDNS_PASSWORD` and `CLOUDDNS_CLIENT_ID` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs, please report here: - -https://github.com/Neilpang/acme.sh/issues/2699 - -## 97. Use dynv6 API to automatically issue a cert -This uses the [dynv6 SSH API](https://dynv6.com/docs/apis) to issue the certificate. You will need a ssh key to authenticate. You can specify your own key with `export KEY="path/to/keyfile"` or if no key is specified one will be created for you which you will have to add [here](https://dynv6.com/keys). In both cases the path to the keyfile will be saved for reuse. - -Alternatively you can use the [HTTP REST API](https://dynv6.github.io/api-spec/). For this you will need a HTTP Token, which you can generate from the [dynv6 website](https://dynv6.com/keys). Use it with `export DYNV6_TOKEN="value"`. - -If both a SSH Key and a HTTP Token are specified the REST API will be used. - -To issue a cert use: -```sh -./acme.sh --issue --dns dns_dynv6 -d www.example.dynv6.net -``` -If you find any bugs, please report here: -https://github.com/acmesh-official/acme.sh/issues/2702 - -## 98. Use All-Inkl.com domain API to automatically issue cert - -You need your login credentials for All-Inkl (https://kas.all-inkl.com). -```sh -export KAS_Login="....." -export KAS_Authtype="sha1" -export KAS_Authdata="....." -``` -Now you are able to issue a cert: -```sh -./acme.sh --issue --dns dns_kas -d example.com -d www.example.com -``` -The `KAS_Login`, `KAS_Authtype` and `KAS_Authdata` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -## 99. Use Constellix domain API - -Get your API credentials at https://manage.constellix.com/users - -```sh -export CONSTELLIX_Key="XXX" -export CONSTELLIX_Secret="XXX" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_constellix -d example.com -d www.example.com -``` - -The `CONSTELLIX_Key` and `CONSTELLIX_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -## 100. Use Namemaster domain API - -Get your API credentials at https://namemaster.de DNS/API - -```sh -export NM_user="XXX" -export NM_sha256="XXX" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_nm -d example.com -d www.example.com -``` - -The `NM_user` and `NM_sha256` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -## 101. Use HostingUkraine domain API - -How get your API credentials: https://api.adm.tools/osnovnie-polozheniya/dostup-k-api/ - -``` -# Your login: -HostingUkraine_Login="XXX" -# Your api token: -HostingUkraine_Token="XXX" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_hostingukraine -d yourdomain.com -d www.yourdomain.com -``` -To issue a wildcard cert: -```sh -./acme.sh --issue --dns dns_hostingukraine -d yourdomain.com -d '*.yourdomain.com' -``` - -The `HostingUkraine_Login` and `HostingUkraine_Token` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -## 102. Use ArvanCloud domain API - -Get your API token at https://npanel.arvancloud.com/profile/api-keys - -```sh -export Arvan_Token="fsdasdfsdfljlbjkljlkjsdfoiwje" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_arvan -d example.com -d www.example.com -``` - -The `Arvan_Token` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -## 103. Use Joker.com domain API - -You must activate Dynamic DNS in Joker.com DNS configuration first. Username and password below refer to Dynamic DNS authentication, not your Joker.com login credentials. See https://joker.com/faq/content/11/427/en/what-is-dynamic-dns-dyndns.html. - -**NOTE:** This script does not support wildcard certificates, because Joker.com API does not support adding two TXT records with the same subdomain. Adding the second record will overwrite the first one. See https://joker.com/faq/content/6/496/en/let_s-encrypt-support.html: -> ... this request will replace all TXT records for the specified label by the provided content... - -Report bugs to https://github.com/acmesh-official/acme.sh/issues/2840 - -```sh -export JOKER_USERNAME="xxxx" -export JOKER_PASSWORD="xxxx" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_joker -d example.com -``` - -The `JOKER_USERNAME` and `JOKER_PASSWORD` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -## 104. Use 1984Hosting domain API - -[1984Hosting](https://1984hosting.com/) does not provide an API to update DNS records -(other than IPv4 and IPv6 dynamic DNS addresses). The `acme.sh` plugin therefore -retrieves and updates domain TXT records by logging into the 1984Hosting -website to read the HTML and posting updates as HTTP. The plugin needs to -know your username and password for the 1984Hosting website. - -```sh -export One984HOSTING_Username= -export One984HOSTING_Password= -``` - -You need only provide this the first time you run the `acme.sh` client with 1984Hosting -validation and then again whenever you change your password at the 1984Hosting site. -The `acme.sh` 1984Hosting plugin does not store your username or password, -but rather saves an authentication token returned by 1984Hosting -in `~/.acme.sh/account.conf` and reuses it when needed. - -Ok, let's issue a cert now: - -```sh -./acme.sh --issue --dns dns_1984hosting -d example.com -d *.example.com -``` - -If you have any issues with 1984Hosting DNS API please report them [here](https://github.com/Neilpang/acme.sh/issues/2851). - -## 105. Use Aruba domain API - -Get your api token following instruction here at https://admin.arubabusiness.it/DashBoard/WebApiGuide.aspx -```sh -export ARUBA_TK="sdfsdfsdfljlbjkljlkjsdfoiwje" #ARUBA API Token -export ARUBA_AK="xxxxxxxxxxxxx" #ARUBA Username -export ARUBA_AS="xxxxxxxxxxxxx" #ARUBA Password -``` -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_aruba -d example.com -d www.example.com -``` - -If you find any bugs, please report here: -https://github.com/JTrotta/acme.sh/issues - - -## 106. Use TransIP domain API: - -First you need to login to your TransIP account to get your [private key](https://www.transip.nl/cp/account/api/). -```sh -export TRANSIP_Username="MyUserName" -export TRANSIP_Key_File="private_key" -``` -Note: TransIP is rather slow, so adding a --dnssleep of 300 might be adviced. -Note 2: if the DNS fails with something like -``` -Please refer to https://curl.haxx.se/libcurl/c/libcurl-errors.html for error code: 60 -== Info: SSL certificate problem: unable to get local issuer certificate -``` -Than maybe the root CA of TransIP is NOT in your cacerts. -You can check this manually with -``` -curl -vvI https://api.transip.nl -``` -Currently, the root CA of TransIP is COMODO_RSA_Certification_Authority.crt -you can add this trusted root CA with -``` ---ca-bundle COMODO_RSA_Certification_Authority.crt -``` - -This script will create a new access token with a default lifetime of 30 minutes. Note that these tokens are by default IP-whitelisted and will not work if your IP is not whitelisted in the Transip control panel. - -To issue a cert: -```sh -./acme.sh --issue --dns dns_transip --dnssleep 300 -d example.com -d www.example.com -``` - -## 107. Use dyndnsfree.de API - -```sh -export DF_user="XXX" -export DF_password="XXX" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_df -d example.com -d www.example.com -``` - -The `df_user` and `df_password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -## 108. Use Njalla API - -```sh -export NJALLA_Token="XXX" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_njalla -d example.com -d www.example.com -``` - -Please report any bugs here: https://github.com/acmesh-official/acme.sh/issues/2913 - - -## 109. Use Vercel API - -Obtain an account token from https://vercel.com/account/tokens. - -```sh -export VERCEL_TOKEN="sdfsdfsdfljlbjkljlkjsdfoiwje" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_vercel -d example.com -d www.example.com -``` - - -## 110. Use Hetzner DNS API - -First you need to create/obtain API tokens on your [Hetzner DNS console](https://dns.hetzner.com/settings/api-token). - -```sh -export HETZNER_Token="somelongrandomstring" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_hetzner -d example.com -d www.example.com -``` - -The `HETZNER_Token` settings will be saved in `[acme.sh-config-home-path]/account.conf` - and will be reused when needed. -The domain(s) zone_id(s) will be saved in `CERT_HOME/[domain]/[domain].conf` -in order to avoid multiple `get_zone_id` requests two months later. - -> If you're not already using the new "gases" name servers (hydrogen, oxygen and helium) -> don't forget to change the domain's whois ns section to them and wait about 24-48 Hours. -> See [Hetzner wiki](https://docs.hetzner.com/dns-console/dns/general/what-has-changed). - -## 111. Use kapper.net DNS API -Contact kapper.net support via support@kapper.net to get your kapper.net DNS Panel API Key and Secret. - -For initialzation call following in commandline -```sh -export KAPPERNETDNS_Key="yourKAPPERNETapikey" -export KAPPERNETDNS_Secret="yourKAPPERNETapisecret" -``` - -You can start the acme.sh with following parameters for testing - -```sh -./acme.sh --issue --dns dns_kappernet -d - -or for a wildcertificate - -./acme.sh --issue --dns dns_kappernet -d -d *. - -``` -Please replace "" with the name of the domain you wish to create a certificate for. - -After the test you can replace your kapper.net DNS Panel API Key and Secret, it is stored in ~/.acme.sh/account.conf. - -For repeated calls use -```sh -./acme.sh --issue --dns dns_kappernet -d -``` - -## 112. Use Wedos API - -First create your WAPI password and add your IP address to access list at customer portal. For more info visit, [https://kb.wedos.com/en/kategorie/wapi-api-interface/](https://kb.wedos.com/en/kategorie/wapi-api-interface/) - -Set variables: - -```sh -export WEDOS_User='xxx@xxx.xx' -export WEDOS_Pass='xxx123' -or use sha1 hash of WEDOS_Pass directly -export WEDOS_Hash='xxxxxxxxxx' -``` - -Issue your certs: -```sh -./acme.sh --issue --dns dns_wedos -d xxx.xx -d www.xxx.xx -``` - -WEDOS_User and WEDOS_Hash will be stored in `~/.acme.sh/account.conf` and will be reused when needed. - -## 113. Use Shellrent API - -Shellrent API offers one method to automatically issue certs. - -First you need to login to your Shellrent account to get your API key. -In order to use the token, you need to authorize your IP to have access to it. -More Info on https://api.shellrent.com and https://guide.shellrent.com -```sh -export SH_Username="usrXXXX" -export SH_Token="sdfsdfsdfljlbjkljlkjsdfoiwje" -``` - -Alternatively, if the certificate only covers a single zone, you can speed up the process by specify the SH_Domain_ID directly: - -```sh -export SH_Username="usrXXXX" -export SH_Token="sdfsdfsdfljlbjkljlkjsdfoiwje" -export SH_Domain_ID="xxxxxxxxxxxxx" -``` -Let's issue a cert now: - -```sh -./acme.sh --issue --dns dns_shellrent -d example.com -d www.example.com -``` -The SH_Username and SH_Token and SH_Domain_ID will be saved in ~/.acme.sh/account.conf and will be reused when needed. - -## 114. Use OpenStack domain API - -This provider supports [OpenStack Designate](https://docs.openstack.org/designate) -for creating DNS records. - -Report any issues to https://github.com/acmesh-official/acme.sh/issues/3054 - -This provider requires the OpenStack Client (python-openstackclient) and -Designate client (python-designateclient) be installed and available in your path. - -It also requires you use Keystone V3 credentials, which can be either password or -application credentials provided as environment variables. Any other -authentication method will not save your credentials for renewal. - -You will most likely want to source your OpenStack RC file to set your environment variables: - -``` -. openrc.sh -``` -or manually like: -```sh -export OS_AUTH_URL=https://keystone.example.com:5000/ -export OS_USERNAME= -export OS_PASSWORD= -export OS_PROJECT_NAME= -export OS_PROJECT_DOMAIN_NAME=Default -export OS_USER_DOMAIN_NAME=Default -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_openstack -d example.com -``` - -Your OpenStack credentials will be saved to `~/.acme.sh/account.conf` and reused on renewal. - -## 115. Use Netlify API - -1. Generate a Personal Access Token at https://app.netlify.com/user/applications - -2. Set your token for use with - -```sh -export NETLIFY_ACCESS_TOKEN='arstdhneioqwfpgjluyzxcvbkm' -``` - -3. Issue a cert with: - -```sh -./acme.sh --issue --dns dns_netlify -d example.com -d www.example.com -``` - -[Report a Netlify-related Bug](https://github.com/acmesh-official/acme.sh/issues/3088) - -## 116. Use Akamai Edge DNS API - -This provider supports the [Akamai Edge DNS](https://developer.akamai.com/api/cloud_security/edge_dns_zone_management/v2.html) API for creating DNS records. - -Report any issues to https://github.com/acmesh-official/acme.sh/issues/3157 - -This provider requires Akamai Open Edgegrid Credentials with EdgeDNS API access authorization. To create and establish your Akamai OPEN CREDENTIALS, see the [authorization](https://developer.akamai.com/legacy/introduction/Prov_Creds.html) and [credentials](https://developer.akamai.com/legacy/introduction/Conf_Client.html) sections of the Akamai Developer Get Started guide. - -The Akamai Open Edgegrid credentials must be specified as environment variables as follows: -```sh -export AKAMAI_CLIENT_TOKEN= -export AKAMAI_ACCESS_TOKEN= -export AKAMAI_CLIENT_SECRET= -export AKAMAI_HOST= -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_edgedns -d example.com -``` - -Your Akamai Edgegrid credentials will be saved to `~/.acme.sh/account.conf` and reused on renewal. - -## 117. Use WEDOS DNS API -WEDOS DNS provider comes from Czech Republic. DNS API implementation for WEDOS require your WEDOS's account to allow WAPI interface. You have to login to WEDOS administration, in setting allow WAPI interface (in days when this manual were written it was for free completelly). Configure WAPI interface to XML interface and register the IP addresses (IPv4 and IPv6) of the server where you plan to use acme.sh. That is from the manual side. - -By doing this setting you should have WEDOS web account username and configured WAPI password. This must be configured to your acme.sh account in the first execution of acme.sh script. To save it to `~/.acme.sh/account.conf` (and for subsequent acme.sh executions) just execute following before first execution of acme.sh script. -```sh -export WEDOS_Username= -export WEDOS_Wapipass= -``` - -Then you can issue a certificates: -```sh -./acme.sh --issue --dns dns_wedos -d "*.example.com" -d "examle.com" -``` - -If you face any bug, please use this [page](https://github.com/acmesh-official/acme.sh/issues/3166) to report it. But before reporting run the acme.sh with `--debug 2` switch and append full acme.sh output to the issue report. - -Enjoy it. - -## 118. Use Websupport DNS API -Obtain an api key and secret from https://admin.websupport.sk/en/auth/apiKey -```sh -export WS_ApiKey="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -export WS_ApiSecret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_websupport -d "*.example.com" -d "examle.com" -``` - -Report any issues to https://github.com/akulumbeg/acme.sh/issues - -## 119. Use infomaniak.com API - -Infomaniak hosts a large number of domains and other hosted services. -Create a token with Domain scope in the API dashboard at -https://manager.infomaniak.com/v3//api/dashboard -and export it as an environment variable: - -```sh -export INFOMANIAK_API_TOKEN=xxx -./acme.sh --issue --dns dns_infomaniak -d example.com -d www.example.com -``` - -Please report any issue to https://github.com/acmesh-official/acme.sh/issues/3188 - -## 120. Use bookmyname.com API - -Bookmyname hosts domains and has a small API. - -Export your login/pass as an environment variable: - -```sh -export BOOKMYNAME_USERNAME=xxx -export BOOKMYNAME_PASSWORD=yyy -./acme.sh --issue --dns dns_bookmyname --dnssleep 600 -d example.com -d www.example.com -``` - -Please report any issue to https://github.com/acmesh-official/acme.sh/issues/3209 - -## 121. Use anexia.com CloudDNS API - -For DNS records managed via https://engine.anexia-it.com/clouddns - -Export your token as an environment variable: - -```sh -export ANX_Token='XXXXXXXXXXXXXXXXXXX' -./acme.sh --issue --dns dns_anx -d example.com -d www.example.com -``` -Please report any issue to https://github.com/acmesh-official/acme.sh/issues/3238 - -## 122. Use Synology DSM Synology DNS Server API -Note that in order the script to be working properly acme.sh should be installed on Synology itself. - -To issue a cert: -```sh -./acme.sh --issue --dns dns_synology_dsm -d example.com -d www.example.com -``` -To issue a wildcard cert: -``` -./acme.sh --issue --dns dns_synology_dsm -d example.com -d *.example.com -``` -You can find more details [here](https://github.com/arabezar/acme.sh/wiki) - -Please report any issue [here](https://github.com/acmesh-official/acme.sh/issues/3248) - -## 123. Use HuaweiCloud API -Export your credentials as an environment variable: - -About "DomainName" parameters see: https://support.huaweicloud.com/api-iam/iam_01_0006.html - -```sh -export HUAWEICLOUD_Username= # IAM Username -export HUAWEICLOUD_Password= -export HUAWEICLOUD_DomainName= -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_huaweicloud -d example.com -d www.example.com -``` -To issue a wildcard cert: -```sh -./acme.sh --issue --dns dns_huaweicloud -d example.com -d *.example.com -``` - -## 124. Use Simply.com API -Export your credentials, you will find your API key by logging in to your Simply.com account [here](https://www.simply.com/controlpanel/account/): - -```sh -export SIMPLY_AccountName= -export SIMPLY_ApiKey= -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_simply -d example.com -d www.example.com -``` -To issue a wildcard cert: -```sh -./acme.sh --issue --dns dns_simply -d example.com -d *.example.com -``` - -## 125. Use World4You API -Export your credentials as an environment variable: - -```sh -export WORLD4YOU_USERNAME= -export WORLD4YOU_PASSWORD= -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_world4you -d example.com -d www.example.com -``` -To issue a wildcard cert: -```sh -./acme.sh --issue --dns dns_world4you -d example.com -d *.example.com -``` - -## 126. Use Scaleway API - -First, you'll need to retrieve your [Api Key](https://www.scaleway.com/en/docs/generate-api-keys/) - -```sh -export SCALEWAY_API_TOKEN='xxx' -``` - -To issue a cert run: - -```sh -./acme.sh --issue --dns dns_scaleway -d example.com -d www.example.com -``` - -Please report any issue [here](https://github.com/acmesh-official/acme.sh/issues/3295) - -## 127 First you need to login to your LS account to get your API Key. - -```sh -export LS_Key="KEY" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_ls -d example.com -d www.example.com -``` - -## 128. Use RackCorp API -Export your credentials as an environment variable: -```sh -export RACKCORP_APIUUID="UUIDHERE" -export RACKCORP_APISECRET="SECRETHERE" -``` -To issue a cert: -```sh -./acme.sh --issue --dns dns_rackcorp -d example.com -d www.example.com -``` -To issue a wildcard cert: -```sh -./acme.sh --issue --dns dns_rackcorp -d example.com -d *.example.com -``` - -## 129. Using the IONOS domain API - -Read [Getting Started](https://developer.hosting.ionos.de/docs/getstarted) to learn how to create an API key. -Export your credentials as environment variables: - -```sh -export IONOS_PREFIX="..." -export IONOS_SECRET="..." -``` - -To issue a certificate, execute: -```sh -./acme.sh --issue --dns dns_ionos -d example.com -d www.example.com -``` - -To issue a wildcard certificate, execute: -```sh -./acme.sh --issue --dns dns_ionos -d example.com -d *.example.com -``` - -## 130. Using the Porkbun API - -Read [Getting Started](https://porkbun.com/api/json/v3/documentation) to learn how to create an API key. -Export your credentials as environment variables: - -```sh -export PORKBUN_API_KEY="..." -export PORKBUN_SECRET_API_KEY="..." -``` - -To issue a certificate, execute: -```sh -./acme.sh --issue --dns dns_porkbun -d example.com -d www.example.com -``` - -To issue a wildcard certificate, execute: -```sh -./acme.sh --issue --dns dns_porkbun -d example.com -d *.example.com -``` - -## 131. Using the Aurora API - -[PCextreme B.V.](https://www.pcextreme.nl/) is a Dutch cloud provider offering cloud services under the family name Aurora. Head over to [DNS & Health Checks > Users](https://cp.pcextreme.nl/auroradns/users) to get your API credentials. -Export your credentials as environment variables: - -```sh -export AURORA_Key="..." -export AURORA_Secret="..." -``` - -To issue a certificate, execute: -```sh -./acme.sh --issue --dns dns_aurora -d example.com -d www.example.com -``` - -Please report any issue to https://github.com/acmesh-official/acme.sh/issues/3459 - -## 132. Using the Azion DNS API - -[Azion](https://www.azion.com/) is a Edge Computing Platform to build modern applications at edge. This API reflects the [Intelligent DNS](https://www.azion.com/en/documentation/products/intelligent-dns/) product. Read this [documentation](https://www.azion.com/en/documentation/products/api/v3/) to create an username/password and permissions to use this plugin. - -Export your username/password as environment variables: -```sh -export AZION_Email="user@example.com" -export AZION_Password="password" -``` - -To issue a certificate, execute: -```sh -./acme.sh --issue --dns dns_azion -d example.com -d www.example.com -``` - -Please report any issue to https://github.com/acmesh-official/acme.sh/issues/3555 - -## 133. Using Oracle Cloud Infrastructure DNS - -See: - -## 134. Utilisation de l'API DNS Hostline Hébergement VPS - -Créer un token API sur votre compte [Hostline Hébergement VPS](https://www.hostline.fr). - -Ajouter les variables API suivantes : -```sh -export HOSTLINE_Token="xxx" (obligatoire) -export HOSTLINE_Url="https://api.hostline.fr" (optionnel) -export HOSTLINE_Ttl="60" ttl custom record (optionnel) -``` - -Pour générer un certificat exécuter la commande correspondante à votre cas : -```sh -./acme.sh --issue --dns dns_hostline -d www.example.com # simple domain -./acme.sh --issue --dns dns_hostline -d example.com -d www.example.com # multi domain -./acme.sh --issue --dns dns_hostline -d example.com -d *.example.com # wildcard -``` - -Les variables `HOSTLINE_Token`, `HOSTLINE_Url` (optionnel) et `HOSTLINE_Ttl` (optionnel) doivent être définies dans le fichier `/root/.acme.sh/account.conf`. - -Si vous rencontrez un problème sur l'API Hostline Hébergement VPS, merci de rapporter votre problème sur le lien suivant : [https://github.com/acmesh-official/acme.sh/issues/3675](https://github.com/acmesh-official/acme.sh/issues/3675) - - -## 135. Use Veesp domain API - -[Veesp](https://veesp.com/) offers HTTP REST [API](https://secure.veesp.com/userapi#dns-82) to manage vital details of account and services like DNS. Your standard login credentials is needed: - -```sh -export VEESP_User="username@domain.com" -export VEESP_Password="password" -``` - -To issue a cert: -```sh -./acme.sh --issue --dns dns_veesp -d example.com -d www.example.com -``` - -The `VEESP_User` and `VEESP_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -Please report any issue to [https://github.com/acmesh-official/acme.sh/issues/3712](https://github.com/acmesh-official/acme.sh/issues/3712) - -## 136. Use cPanel DNS systems - -First you need to log into the cPanel interface and generate an API key for your account (under Security -> Manage API Tokens). -Then set your username, api token and hostname: - -```sh -export cPanel_Username=username -export cPanel_Apitoken=apitoken -export cPanel_Hostname=https://hostname:port -``` -example - -```sh -export cPanel_Username=myadminuseratnordicway -export cPanel_Apitoken=CXJ8HRXFNS363RQ71Z51TKM9KTHRFZVE -export cPanel_Hostname=https://cp04.nordicway.dk:2083 -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_cpanel -d example.com -d www.example.com -``` - -(see https://api.docs.cpanel.net/cpanel/introduction/#cpanel-or-webmail-session-url-1 regarding cPanel ports) - -The `cPanel_Username`, `cPanel_Apitoken` and `cPanel_Hostname` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -Please report any issue to [https://github.com/acmesh-official/acme.sh/issues/3732](https://github.com/acmesh-official/acme.sh/issues/3732) - -## 137. Use ISPMan domain API - -!!! IMPORTANT: Make sure the verson of ISPMan supports TXT records !!! - -The `dns_ispman.sh` api Adds & Deletes domain TXT records by authenticating into the [ISPMan](http://ispman.sourceforge.net/) Customer Control Panel and executing related HTTP POST & GET requests. - -The `dns_ispman.sh` api requires your `` and `` for authentication: -```sh -export ISPMan_Username= -export ISPMan_Password= -``` - -The `ISPMan_Username` and `ISPMan_Password` will be saved in `$LE_WORKING_DIR/account.conf` and will be reused for certificate renewals. - -Ok, let's issue a cert: - -```sh -./acme.sh --issue --dns dns_ispman -d example.com -d *.example.com -``` - -Please report bugs to [https://github.com/acmesh-official/acme.sh/issues/3751](https://github.com/acmesh-official/acme.sh/issues/3751) - -## 138. Use dnsHome.de DNS API - -```sh -export DNSHOME_Subdomain="" -export DNSHOME_SubdomainPassword="" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_dnshome -d subdomain.ddnsdomain.tld -``` - -The `DNSHOME_Subdomain` and `DNSHOME_SubdomainPassword` will be saved in the domain conf and will be reused when needed. - -Please report any issue to [https://github.com/acmesh-official/acme.sh/issues/3819](https://github.com/acmesh-official/acme.sh/issues/3819) - -## 139. Use mythic-beasts.com DNS API - -First obtain you API key from the control panel. - -```sh -export MB_AK="Key" -export MB_AS="Secret" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_mythic_beasts --domain example.com -``` - -The credentials will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -Please report any issue to [https://github.com/acmesh-official/acme.sh/issues/3848](https://github.com/acmesh-official/acme.sh/issues/3848) - - -## 140. Use s-dns.de API - -First generate your dns zone key. Open your existing nameserver entry, click on [Passwort für dynamic DNS generieren] and save your zone. This generates a new key for your zone. - -```sh -export SDNS_ZONE_KEY="Key" -``` - -Ok, let's issue a cert now: -```sh -./acme.sh --issue --dns dns_sdns --domain example.com -``` - -S-dns nameservers use anycast. It is therefore possible that the server next to your location already provides the new record, while the CA reaches another one that does not have the TXT record yet. To avoid such timing errors the dnssleep flag can be set to a value of 240 seconds. - -```sh -./acme.sh --issue --dns dns_sdns --domain example.com --dnssleep 240 -``` - -## 141. Using the united-domains reselling DNS API - -Create an account at [ud reselling](https://www.ud-reselling.com/). - -There is no option to use an API key, so you just need to set your credentials as environment variables: - -```sh -export UDR_USER="..." -export UDR_PASS="..." -``` - -To issue a certificate, execute: -```sh -./acme.sh --issue --dns dns_udr -d example.com -d www.example.com -``` - -To issue a wildcard certificate, execute: -```sh -./acme.sh --issue --dns dns_udr -d example.com -d *.example.com -``` - -The `UDR_USER` and `UDR_PASS` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -## 142. Using the curanet DNS API - -Login to your curanet account, create a new API Application, and use client_id and secret as shown below - -```sh -export CURANET_AUTHCLIENTID="..." -export CURANET_AUTHSECRET="..." -``` - -To issue a certificate, execute: -```sh -./acme.sh --issue --dns dns_curanet -d example.com -d www.example.com -``` - -To issue a wildcard certificate, execute: -```sh -./acme.sh --issue --dns dns_curanet -d example.com -d *.example.com -``` - -The `CURANET_AUTHCLIENTID` and `CURANET_AUTHSECRET` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -## 143. Use ArtFiles.de DNS API - -First, verify that API access is already enabled: -1. Go to ArtFiles.de's **DCP** (Domain Control Panel). -2. Click **Passwords** in the left menu. -3. To the menu's right, the drop-down menu for **Active** is either `active` or `inactive`. -4. If **Active** is already set to `active`, skip this step. Otherwise, enter your desired password into both text boxes, save it somewhere else (e. g. Firefox, KeePass, etc.) & click **Apply** below. -5. Copy **User name**'s value, i. e. the one that starts with `api` & then continues with your account number which is something like `a12345678`. - -Export `AF_API_Username` & `AF_API_Password` only once (saved into domain's config file upon 1st successful script run): -```sh -export AF_API_Username="api12345678" -export AF_API_Password="apiPassword" -``` - -To issue a certificate, execute: -```sh -./acme.sh --issue --dns dns_artfiles -d yourDomain.tld -``` -To issue a wildcard certificate, execute: -```sh -./acme.sh --issue --dns dns_artfiles -d yourDomain.tld -d *.yourDomain.tld -``` - -Please report any issue at [Eagle3386/acme.sh/issues](https://github.com/Eagle3386/acme.sh/issues). - -## 144. Use Geoscaling.com DNS2 - -Create an account at [Geoscaling](https://www.geoscaling.com/). - -Set your credentials as environment variables: - -```sh -export GEOSCALING_Username="..." -export GEOSCALING_Password="..." -``` - -To issue a certificate, execute: -```sh -./acme.sh --issue --dns dns_geoscaling -d example.com -d www.example.com -``` - -To issue a wildcard certificate, execute: -```sh -./acme.sh --issue --dns dns_geoscaling -d example.com -d '*.example.com' -``` - -The `GEOSCALING_Username` and `GEOSCALING_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. -Report bugs [at this issue](https://github.com/acmesh-official/acme.sh/issues/3969). - -## 145. Use fornex.com API - -Get an API key in your fornex.com account page. Then - -```sh -export FORNEX_API_KEY="Key" -``` - -To issue a cert, run command: -```sh -./acme.sh --issue --dns dns_fornex -d example.com -``` -To issue a wildcard certificate, execute: -```sh -./acme.sh --issue --dns dns_fornex -d example.com -d '*.example.com' -``` - -## 146. Use DNS.Services API - -Use your credentials - - export DnsServices_Username=user@example.com - export DnsServices_Password=YouPassword - - -To issue a cert, run command: - - ./acme.sh --issue --dns dns_dnsservices -d example.com - - -To issue a wildcard certificate, run command: - - ./acme.sh --issue --dns dns_dnsservices -d example.com -d '*.example.com' - -## 147. Use Nodion DNS API - -You are able to create a free account on [app.nodion.com](https://app.nodion.com) and add an API key used by acme.sh by visiting the [settings page](https://app.nodion.com/user/security). Please take this token and set it as env variable. - -```sh -export NODION_API_KEY="Token" -``` -To issue a certificate, execute: - -```sh -acme.sh --issue --dns dns_nodion -d example.com -``` - -To issue a wildcard certificate, execute: - -```sh -acme.sh --issue --dns dns_nodion -d *.example.com -``` - -## 148. Use dns.la API - -Use your credentials - - export LA_Id="appid" - export LA_Key="apikey" - - -To issue a cert, run command: - - ./acme.sh --issue --dns dns_la -d example.com - - -To issue a wildcard certificate, run command: - - ./acme.sh --issue --dns dns_la -d example.com -d *.example.com - -## 149. Use Yandex Cloud DNS API - -Create a new service account with role `dns.editor` and [create authorized key](https://cloud.yandex.com/en-ru/docs/iam/operations/authorized-key/create) for him. - -Required parameters: -```sh -export YC_Folder_ID="YC Folder ID" -export YC_SA_ID="Service Account ID" -export YC_SA_Key_ID="Service Account IAM Key ID" -# You need use YC_SA_Key_File_PEM_b64 or YC_SA_Key_File_Path -export YC_SA_Key_File_PEM_b64="Base64 content of private.key" -export YC_SA_Key_File_Path="/path/to/private.key" -``` - -Optional parameters: -```sh -export YC_Zone_ID="DNS Zone ID" -``` - -Now you cann issue a cert: - -```sh -./acme.sh --issue --dns dns_yc -d example.com -d www.example.com -``` - -Both, `YC_Folder_ID`, `YC_SA_ID`, `YC_SA_Key_ID`, `YC_SA_Key_File_PEM_b64` or `YC_SA_Key_File_Path` and `YC_Zone_ID` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -## 150. Use Bunny DNS API to automatically issue cert - -Find your API key at https://panel.bunny.net/account -Then export the key: - -```sh -export BUNNY_API_KEY="your-api-key-goes-here" -``` - -Then you can issue a cert: -```sh -./acme.sh --issue --dns dns_bunny -d example.com -d www.example.com -``` - -The `BUNNY_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. - -If you find any bugs with the Bunny DNS API integration, please report them here: https://github.com/Neilpang/acme.sh/issues/4296 - -## 151. Use Selfhost DNS API - -- create a new TXT record for a subdomainname with the needed prefix e.g. "_acme-challenge.example.com" (default) or "alias.example.com" (dns alias mode) - - for wildcard subdomains add a second TXT record for the identical subdomainname -- edit the TXT record and note the ID in (...) behind the subdomainname -- export each subdomainname (including the prefix) and the corresponding record IDs in SELFHOSTDNS_MAP like "subdomainname:RID1:RID2" - - at least one RID must be set, up to two are supported for wildcard subdomains - - each entry must be seperated by a space -- export username and password in SELFHOSTDNS_USERNAME and SELFHOSTDNS_PASSWORD - -_Note: For `username` you have to use your account / customer number. You can find them in any invoice or on the right top of the selfhost dashboard._ - -``` -export SELFHOSTDNS_USERNAME="myname" -export SELFHOSTDNS_PASSWORD="mypass" -export SELFHOSTDNS_MAP="_acme-challenge.example.com:12345:98765 alias.example.com:11111" - -acme.sh --issue -d example.com --dns dns_selfhost -``` - -# ################## -# Use custom API - -If your API is not supported yet, you can write your own DNS API. - -Let's assume you want to name it 'myapi': - -1. Create a bash script named `~/.acme.sh/dns_myapi.sh`, -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. -3. Then you can use your API to issue cert like this: - -```sh -./acme.sh --issue --dns dns_myapi -d example.com -d www.example.com -``` - -For more details, please check our sample script: [dns_myapi.sh](https://github.com/Neilpang/acme.sh/blob/master/dnsapi/dns_myapi.sh) - -See: [DNS API Dev Guide](https://github.com/Neilpang/acme.sh/wiki/DNS-API-Dev-Guide) - - - ----------------------------------- -**More APIs coming soon...** +**More APIs see here...** -# Use lexicon DNS API - -[How to use lexicon DNS API](https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-DNS-API) +[More APIs](https://github.com/Neilpang/acme.sh/wiki/dnsapi2)