GENDNS Documentation

API Documentation

This API allows you to manage DNS records for your domain using the GENDNS platform.

To use this API, you'll need to obtain:

  • A hostname and zone (often gendns.uk).
  • A Username.
  • A Secret (password).

Your username/secret is tied to your GEN Account, so that must be active for GENDNS to function. Remember API calls are rate limited, and abusive IP's will be blocked automatically.

Getting your IP Address

https://www.gendns.uk/ip?f=text

Returns

195.195.195.1

https://www.gendns.uk/ip?f=json

Returns

{ "ip": "195.195.195.1" }

https://www.gendns.uk/ip?f=xml

Returns

<?xml version="1.0" encoding="UTF-8"?><root><ip>149.255.124.14</ip></root>

This provides your current public IP Address in various formats as required.

GET Request Example

https://www.gendns.uk/dns?h=testdns&u=123-123-123-123&i=195.195.195.1&p=q35yq35q3e5gq35gq35h

the i parameter is optional, and if not provided we'll try and determine the IP from the caller

Synology Configuration

  • Go to Control Panel > External Access > DDNS
  • Click Add and select "Custom Provider"
  • Set the following:
    • Service provider: GENDNS
    • Query URL:
      https://www.gendns.uk/dns?h=__HOSTNAME__&u=__USERNAME__&i=__IPADDRESS__&p=__PASSWORD__
  • Fill in your hostname, username, and password
  • Click OK to save
Screenshot 2025-07-03 at 17.27.48

ddclient Configuration


protocol=dyndns2
use=web, web=https://www.gendns.uk/ip?f=text
server=www.gendns.uk
ssl=yes
login=your_username
password=your_password
testdns
                

Replace your_username, your_password, and testdns with your actual values.

Programmatic DNS

GENDNS offers a powerful API for programmatic DNS management. The following endpoints are available for managing your DNS records:

  • getZone: Retrieve information about a DNS zone
  • putZone: Create or update a DNS zone
  • getRR: Retrieve a specific resource record
  • putRR: Create or update a resource record

To use the GENDNS API, you'll need an API key. Please contact our support team to obtain your API key. All API requests should include your API key in the header for authentication.

API Request Example

curl -X GET "https://api.gendns.uk/v1/getZone?zone=example.com&u=username&p=secret"

Replace YOUR_API_KEY with your actual API key.

For detailed information on each endpoint, including required parameters and response formats, please refer to our comprehensive API documentation.