Report bugs to cPanel dns api

[arnebjarne]

This is the place to report bugs in the cPanel DNS API.

If you experience a bug, please report it in this issue.

Thanks!

[deejayexe]

Hi!
i install acme.sh in docker with last release acme.sh:dev
But when i try it with my api user cPanel_Username, cPanel_Apitoken, cPanel_Hostname , find this error:
No matching root domain for _acme-challenge.subdomain.domain.com found

docker exec acme.sh --issue --force --log --dns dns_cpanel -d subdomain.domain.com

[Mon Oct 11 10:52:13 UTC 2021] Getting domain auth token for each domain
[Mon Oct 11 10:52:15 UTC 2021] Getting webroot for domain='subdomain.domain.com'
[Mon Oct 11 10:52:15 UTC 2021] Adding txt value: XXXXXXXXX_Tfe_Aj1I9cO63CQl249J-vs4OBdYdEYgnA for domain: _acme-challenge.subdomain.domain.com
[Mon Oct 11 10:52:15 UTC 2021] Adding TXT record to cPanel based system
[Mon Oct 11 10:52:15 UTC 2021] No matching root domain for _acme-challenge.subdomain.domain.com found
[Mon Oct 11 10:52:15 UTC 2021] Error add txt for domain:_acme-challenge.subdomain.domain.com
[Mon Oct 11 10:52:15 UTC 2021] Please check log file for more details: /acme.sh/acme.sh.log

This error of matching root domain also i have with domain or other subdomain.
In acme.sh.log:

[Mon Oct 11 10:41:36 UTC 2021] timeout=
[Mon Oct 11 10:41:36 UTC 2021] displayError='1'
[Mon Oct 11 10:41:36 UTC 2021] _CURL='curl --silent --dump-header /acme.sh/http.header -L '
[Mon Oct 11 10:41:36 UTC 2021] ret='0'
[Mon Oct 11 10:41:36 UTC 2021] _hcode='0'
[Mon Oct 11 10:41:36 UTC 2021] First detect the root zone
[Mon Oct 11 10:41:36 UTC 2021] Retrying GET
[Mon Oct 11 10:41:36 UTC 2021] GET
[Mon Oct 11 10:41:36 UTC 2021] url='https://xxxxxxxxxxxxxxxxx:2083/json-api/cpanel?cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=ZoneEdit&cpanel_jsonapi_func=fetchzones'
[Mon Oct 11 10:41:36 UTC 2021] timeout=
[Mon Oct 11 10:41:36 UTC 2021] displayError='1'
[Mon Oct 11 10:41:36 UTC 2021] _CURL='curl --silent --dump-header /acme.sh/http.header -L '
[Mon Oct 11 10:41:37 UTC 2021] ret='0'
[Mon Oct 11 10:41:37 UTC 2021] _hcode='0'
[Mon Oct 11 10:41:37 UTC 2021] _result is: {"cpanelresult":{"apiversion":"2","error":"Access denied","data":{"reason":"Access denied","result":"0"},"type":"text"}}
[Mon Oct 11 10:41:37 UTC 2021] _domains is: apiversion
[Mon Oct 11 10:41:37 UTC 2021] Checking if _acme-challenge.subdomain.domain.com ends with apiversion
[Mon Oct 11 10:41:37 UTC 2021] No matching root domain for _acme-challenge.subdomain.domain.com found
[Mon Oct 11 10:41:37 UTC 2021] Error add txt for domain:_acme-challenge.subdomain.domain.com
[Mon Oct 11 10:41:37 UTC 2021] _on_issue_err
[Mon Oct 11 10:41:37 UTC 2021] Please check log file for more details: /acme.sh/acme.sh.log
[Mon Oct 11 10:41:37 UTC 2021] url='https://acme.zerossl.com/v2/DV90/chall/cb5CcYBuWDYV4RsKp4h-7Q'
[Mon Oct 11 10:41:37 UTC 2021] payload='{}'
[Mon Oct 11 10:41:37 UTC 2021] Retrying post
[Mon Oct 11 10:41:37 UTC 2021] POST
[Mon Oct 11 10:41:37 UTC 2021] _post_url='https://acme.zerossl.com/v2/DV90/chall/cb5CcYBuWDYV4RsKp4h-7Q'
[Mon Oct 11 10:41:37 UTC 2021] _CURL='curl --silent --dump-header /acme.sh/http.header -L '
[Mon Oct 11 10:41:37 UTC 2021] _ret='0'
[Mon Oct 11 10:41:37 UTC 2021] _hcode='0'
[Mon Oct 11 10:41:37 UTC 2021] code='200'
[Mon Oct 11 10:41:37 UTC 2021] pid
[Mon Oct 11 10:41:37 UTC 2021] No need to restore nginx, skip.
[Mon Oct 11 10:41:37 UTC 2021] _clearupdns
[Mon Oct 11 10:41:37 UTC 2021] dns_entries
[Mon Oct 11 10:41:37 UTC 2021] skip dns.

Also i test with manual (--dns
--yes-I-know-dns-manual-mode-enough-go-ahead-please) --issue and i dont have problem if i put txt acme challenge but manual it isnt a solution becasue i need to automation it.

Thanks.

[arnebjarne]

result is: {"cpanelresult":{"apiversion":"2","error":"Access denied","data":{"reason":"Access denied","result":"0"},"type":"text"}}

Your username or api token is not right.

[deejayexe]

result is: {"cpanelresult":{"apiversion":"2","error":"Access denied","data":{"reason":"Access denied","result":"0"},"type":"text"}}

Your username or api token is not right.

No it is correct, also I deleted and created newly but always say same error, maybe it is other problem?

[arnebjarne]

result is: {"cpanelresult":{"apiversion":"2","error":"Access denied","data":{"reason":"Access denied","result":"0"},"type":"text"}}
Your username or api token is not right.

No it is correct, also I deleted and created newly but always say same error, maybe it is other problem?

May I ask how you have configured your username, token and url inside the docker container?

[deejayexe]

Inside -v /share/acme account.conf i put export cPanel_Username=username, export cPanel_Apitoken=xxxxxxxxxx, export cPanel_Hostname=https://url:2083 , if i put wrong url it dont connect and if i put incorrect username o apitoken return [Tue Oct 12 18:04:43 UTC 2021] cPanel Login failed for user username111
I put this
export cPanel_Username=username
export cPanel_Apitoken=xxxxxxxxxx
export cPanel_Hostname=https://url:2083

and return this in account.conf:
SAVED_cPanel_Username='username'
SAVED_cPanel_Apitoken='xxxxxxxxxx'
SAVED_cPanel_Hostname='https://url:2083'

But without luck always same message:
No matching root domain for _acme-challenge.subdomain.domain.com found
[Tue Oct 12 18:08:48 UTC 2021] Error add txt for domain:_acme-challenge.subdomain.domain.com

[arnebjarne]

Inside -v /share/acme account.conf i put export cPanel_Username=username, export cPanel_Apitoken=xxxxxxxxxx, export cPanel_Hostname=https://url:2083 , if i put wrong url it dont connect and if i put incorrect username o apitoken return [Tue Oct 12 18:04:43 UTC 2021] cPanel Login failed for user username111 I put this export cPanel_Username=username export cPanel_Apitoken=xxxxxxxxxx export cPanel_Hostname=https://url:2083

and return this in account.conf: SAVED_cPanel_Username='username' SAVED_cPanel_Apitoken='xxxxxxxxxx' SAVED_cPanel_Hostname='https://url:2083'

But without luck always same message: No matching root domain for _acme-challenge.subdomain.domain.com found [Tue Oct 12 18:08:48 UTC 2021] Error add txt for domain:_acme-challenge.subdomain.domain.com

I cannot say why it fails for you.
I have just tested with a docker image

docker run --rm  -it -v "$(pwd)/out":/acme.sh --net=host neilpang/acme.sh --issue -d example.com --standalone

echo "SAVED_cPanel_Username='MY_CPANEL_ADMIN_ACCOUNT'" | sudo tee -a $(pwd)/out/account.conf
echo "SAVED_cPanel_Apitoken='MY_CPANEL_TOKEN'" | sudo tee -a $(pwd)/out/account.conf
echo "SAVED_cPanel_Hostname='https://cp04.nordicway.dk:2083'" | sudo tee -a $(pwd)/out/account.conf

docker run --rm -it -v "$(pwd)/out":/acme.sh --net=host neilpang/acme.sh --set-default-ca --server letsencrypt
docker run --rm -it -v "$(pwd)/out":/acme.sh --net=host neilpang/acme.sh --issue --force --staging --dns dns_cpanel --dnssleep 300 -d '*.saltbaek.dk'

works for me (note I used LE's staging environment).

[arnebjarne]

Inside -v /share/acme account.conf i put export cPanel_Username=username, export cPanel_Apitoken=xxxxxxxxxx, export cPanel_Hostname=https://url:2083 , if i put wrong url it dont connect and if i put incorrect username o apitoken return [Tue Oct 12 18:04:43 UTC 2021] cPanel Login failed for user username111 I put this export cPanel_Username=username export cPanel_Apitoken=xxxxxxxxxx export cPanel_Hostname=https://url:2083

and return this in account.conf: SAVED_cPanel_Username='username' SAVED_cPanel_Apitoken='xxxxxxxxxx' SAVED_cPanel_Hostname='https://url:2083'

But without luck always same message: No matching root domain for _acme-challenge.subdomain.domain.com found [Tue Oct 12 18:08:48 UTC 2021] Error add txt for domain:_acme-challenge.subdomain.domain.com

You can test your api key with

curl -s -H 'Authorization: cpanel CPANEL_ADMIN_ACCOUNT:CPANEL_TOKEN' 'https://CPANEL_URL:2083/json-api/cpanel?cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=ZoneEdit&cpanel_jsonapi_func=fetchzones'

Of course replace CPANEL_ADMIN_ACCOUNT and CPANEL_TOKEN with your settings...

[Xebozone]

Hello,

I'm trying to the the cPanel API with NameCheap cPanel.
I've exported the correct data and ran command:
acme.sh --issue --dns dns_cpanel -d SOMEDOMAIN.com

This fails. The command appears to have the error:
Token authentication allows access to UAPI or API 2 calls only

Log attached:
log.log

Note: I tried testing the API key with:
curl -s -H 'Authorization: USERNAME:KEY' 'https://URL:2083/json-api/cpanel?cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=ZoneEdit&cpanel_jsonapi_func=fetchzones'
and this was fine

[arnebjarne]

Hello,

I'm trying to the the cPanel API with NameCheap cPanel. I've exported the correct data and ran command: acme.sh --issue --dns dns_cpanel -d SOMEDOMAIN.com

This fails. The command appears to have the error: Token authentication allows access to UAPI or API 2 calls only

Log attached: log.log

Note: I tried testing the API key with: curl -s -H 'Authorization: USERNAME:KEY' 'https://URL:2083/json-api/cpanel?cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=ZoneEdit&cpanel_jsonapi_func=fetchzones' and this was fine

[Fri Oct 15 22:05:54 EDT 2021] url='premium131.web-hosting.com:2083/json-api/cpanel?cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=ZoneEdit&cpanel_jsonapi_func=fetchzones'

From the log it looks like you have set the URL to premium131.web-hosting.com without the https
It must be

cPanel_Hostname=https://premium131.web-hosting.com

It might be confusing to people that i named the variable Hostname and not URL. A hostname is only a name wereas a URL can/may be prefixed with protocol (http://, https://, ftp:// etc)

[Xebozone]

I want to slap myself now. Thanks!

[deejayexe]

result is: {"cpanelresult":{"apiversion":"2","error":"Access denied","data":{"reason":"Access denied","result":"0"},"type":"text"}}

Your username or api token is not right.

Finally i solve it, with hosting and api token, now i can run command without issues.
Thanks for ur pattient.

[mcn18]

This script does not work when a subdomain is the main cPanel domain. For example, my CP account domain is sub.example.com so it should add DNS record to the sub.example.com zone but instead it tried to add it to the example.com zone.

[arnebjarne]

This script does not work when a subdomain is the main cPanel domain. For example, my CP account domain is sub.example.com so it should add DNS record to the sub.example.com zone but instead it tried to add it to the example.com zone.

Yes, this was how I made the script.