API Documentation

Integrate DingDns into your workflow with our REST API.

Quick Start

  1. Get your API key from the Dashboard
  2. Check server health: GET /health
  3. List your zones: GET /api/zones with X-API-Key header

Authentication

All API requests require an X-API-Key header.

curl -H "X-API-Key: dk_your_key_here" \
     https://your-server.com/api/zones

Keys are stored hashed and shown in full only once, at creation — copy yours right away. Requests are rate-limited to 120 per minute per IP.

Endpoints

Method Path Description
GET/healthHealth check
GET/api/zonesList all zones
POST/api/zonesCreate zone
GET/api/records/zone/:idList records
POST/api/records/zone/:idCreate record
PUT/api/records/:idUpdate record
DEL/api/records/:idDelete record
GET/api/subdomainsList your subdomains
POST/api/subdomainsAllocate a subdomain under a base domain
POST/api/subdomains/:id/recordsCreate record under a subdomain
GET/api/base-domainsList offered base domains
GET/ddns/ipEcho your public IP (no auth)
GET/ddns/updateDDNS update (token auth, not under /api)

For the complete API reference, see the full documentation on GitHub.