How to use the HTTP API

Simple DNS Plus includes a HTTP API through which you can perform most of the operations that are available through the GUI.

The HTTP API is REST based and data is generally exchanged in JSON format.

This HTTP API is not intended as a direct user interface, but rather a way to communicate with Simple DNS Plus from other applications over the network. For example ASP pages running on IIS, PHP pages on Apache, javascript running on a browser, etc.

By default, Simple DNS Plus listens for HTTP requests on IP address 127.0.0.1 port 8053. With this default configuration, you can open the HTTP API "home page" in your browser using http://127.0.0.1:8053. There you will find a link to the HTTP API specification file (Swagger / OpenAPI format) that you can use to explore and test the HTTP API.

You can change these setting in the Options dialog / HTTP API section.

CORS support

If you want to access the HTTP API with javascript running on a web-page, you need to enable and configure CORS. You do this in the Options dialog / HTTP API section.

SSL

The HTTP API can be served securely via SSL (https://...). For details on how to associate an SSL certificate with the HTTP API URL, see https://simpledns.com/kb/163/how-to-bind-an-ssl-certificate-to-the-http-api.

Debugging log files

To see the exact details of HTTP API client requests, you can enable this in the Options dialog / Logging / Log files section / "Write HTTP API debugging log files (one file per HTTP request)".

WARNING: This can quickly add up to a lot of log files and data. Make sure to only enable this when needed.

 Comments
Gravatar
7 Apr 2018 15:54 UTC
Rudy Affandi
Is is possible to add/enable JSON output as one of the available output options?
JH Software
10 Apr 2018 09:03 UTC
JH Software
We are working on this for the upcoming v. 7.0 release. This will be available soon.
JH Software
19 May 2018 11:30 UTC
JH Software
We have just released v. 7.0 which supports this. See https://simpledns.com/kb/162
Gravatar
25 Apr 2018 11:16 UTC
Dominic Gingras
Where is the best place to view API request log?
JH Software
19 May 2018 11:28 UTC
JH Software
In the new Simple DNS Plus v. 7.0, you can enable detailed logging for the HTTP API in the Options dialog / Loggin / Log files section.
(Never published. Used for replies and to show your Gravatar icon. Never used for any other purpose.)
Connect