RESTful API Interface

API Access

Conexim DNS provides external access by means of REST API and Dynamic DNS (DDNS) updates. See API documentation

Managing Authentication

Conexim DNS manages authentication for DDNS and API access as follows:

  1. An API key is created that can be used for DDNS and/or API access.
  2. Dynamic DNS is authenticated using the API Key ID (12 digit unique ID) and a user-specified password.
  3. API Access is authenticated by hashing the request against a secret, pre-shared key. The key itself is never sent from the client to the server to ensure the request is secure.


A number of permissions are available for authenticating API and DDNS requests:



Read (GET): Allows properties of a DNS record/zone to be read.

Update (PUT): Enable updating of DNS records/zone, but cannot create new records.

Create (POST): Create a new DNS record/zone, but not update any existing ones.

Delete (DELETE): Allows deletion of a DNS record/zone.

Dynamic DNS: Enables DDNS access. Enabling DDNS access enforces that you enter a password to enable Dynamic DNS authentication. If you wish to enable DDNS, but not API access, only enable Dynamic DNS and disable the API-specific permissions (GET/PUT/POST/DELETE).

In addition to key/password authentication, access to the API or Dynamic DNS can be restricted by IP address or subnet. This is useful in the following situations:

  1. You use Dynamic DNS and cannot restrict DDNS by IP address, but know what subnet the request is coming from. This can be configured in CIDR (Classless Inter-domain Routing) format.
  2. You wish to limit API access from specific IP addresses.

Conexim DNS API

Please refer to the Conexim DNS API Guide for details on how to make use of the API.