De REST API van Plesk gebruikt een geheime sleutel, meegestuurd in een X-API-Key-header. Twee regels bepalen alles hieronder. Alleen een Plesk-beheerder kan de REST API gebruiken, dus de sleutel hoort bij zo'n beheerder. En een sleutel is gebonden aan een IP-adres, waar de meeste mislukte koppelingen door ontstaan.
De IP-binding
Een sleutel werkt alleen vanaf het IP-adres waarvoor hij is gemaakt. Laat je het adres weg, dan gebruikt Plesk het adres van degene die de aanvraag doet. Maak je hem vanaf je laptop, dan werkt hij vanaf je laptop en nergens anders.
Maak hem aan voor het adres waarvandaan DNSense verbindt. Weet je niet welk dat is, vraag het dan eerst aan DNSense-support.
Optie 1: de opdrachtregel
Voer op de Plesk-server uit:
plesk bin secret_key -c -ip-address <IP-adres>
De uitvoer is de sleutel. Kopieer hem.
Optie 2: de REST API
Stuur een JSON-body naar het key-eindpunt met basisauthenticatie. Voeg een ip-veld toe om hem te binden, en eventueel een description:
curl -X POST --user root:password \
-H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"ip": "<IP-adres>", "description": "dnsense"}' \
"https://<host>:8443/api/v2/auth/keys"
Het antwoord is {"key": "..."}. Sleutels kun je niet als URL-argument meegeven, alleen in de header.
Waar in het paneel
Tools & Settings > Remote API (REST) opent de API-referentie en playground. Handig om de sleutel te testen. De sleutel zelf maak je met de twee methoden hierboven.
Koppelen aan DNSense
Voeg een koppeling toe, kies Plesk en vul in:
- Host van je paneel. Poort
8443wordt aangenomen. Noem een andere poort in de host als die van jou afwijkt. - API key, de geheime sleutel die je net maakte.
Test de sleutel eerst met curl -H "X-API-Key: <sleutel>" https://<host>:8443/api/v2/server. Een JSON-antwoord betekent dat hij werkt vanaf waar jij zit. Kan DNSense nog steeds niet verbinden, dan is de IP-binding de eerste plek om te kijken.