{"id":30275530,"url":"https://github.com/vooon/zoneomatic","last_synced_at":"2026-04-08T14:05:37.098Z","repository":{"id":308540411,"uuid":"1033057218","full_name":"vooon/zoneomatic","owner":"vooon","description":"DNS API server for self-hosted DynDNS","archived":false,"fork":false,"pushed_at":"2026-04-04T10:21:23.000Z","size":183,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-04T12:27:46.086Z","etag":null,"topics":["acme-dns","dns","dnsapi"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vooon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-06T08:33:12.000Z","updated_at":"2026-04-04T10:21:28.000Z","dependencies_parsed_at":"2025-08-06T14:31:55.235Z","dependency_job_id":"f61da4dc-f41c-4f9b-9b6e-b2b3cbf17bd3","html_url":"https://github.com/vooon/zoneomatic","commit_stats":null,"previous_names":["vooon/zoneomatic"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/vooon/zoneomatic","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vooon%2Fzoneomatic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vooon%2Fzoneomatic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vooon%2Fzoneomatic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vooon%2Fzoneomatic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vooon","download_url":"https://codeload.github.com/vooon/zoneomatic/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vooon%2Fzoneomatic/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31558408,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T10:21:54.569Z","status":"ssl_error","status_checked_at":"2026-04-08T10:21:38.171Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["acme-dns","dns","dnsapi"],"created_at":"2025-08-16T09:41:12.460Z","updated_at":"2026-04-08T14:05:37.077Z","avatar_url":"https://github.com/vooon.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"Zone-o-Matic\n============\n\nDNS API server for self-hosted DynDNS / ACME.\n\nI use CoreDNS to serve my zones, unfortunately it does not support nsupdate protocol.\nIt does auto-reload modified zone files, so an external service can update them.\n\nThis project aims to provide DDNS API similar to *no-ip.com*,\nso existing [ddns-scripts][ddns] can interact with it.\n\nAs a secondary feature it also provides API, which [acme-sh][acmesh] can use\nto issue TLS certificates using `dns-01` challenge.\n\nIt also supports [LEGO HTTP-Request][legohttp] protocol for the same challenge.\n\nYou can use OpenWRT package from my feed: [vooon/my-openwrt-feed][owrtpkg].\n\n\nQuick start\n-----------\n\nStart server:\n\n```bash\nzoneomatic --htpasswd ./htpasswd --zone ./example.com.zone --listen 0.0.0.0:9999\n```\n\nUpdate DDNS A record:\n\n```bash\ncurl -u \"user:password\" \\\n  \"http://127.0.0.1:9999/nic/update?hostname=host.example.com\u0026myip=203.0.113.10\"\n```\n\nUpdate ACME TXT with `acme-dns` compatible endpoint:\n\n```bash\ncurl -u \"user:password\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"subdomain\":\"host.example.com\",\"txt\":\"SomeRandomToken\"}' \\\n  \"http://127.0.0.1:9999/acme/update\"\n```\n\nSecurity notes\n--------------\n\n- Authentication uses htpasswd entries with bcrypt hashes.\n- The server does not terminate TLS by itself; run it behind a reverse proxy with HTTPS.\n- If you enable `--accept-proxy`, only expose the service behind a trusted proxy/LB.\n\n\nCommand line options\n--------------------\n\n```\nUsage: zoneomatic --htpasswd=FILE --zone=FILE,... [flags]\n\nDNS Zone file updater\n\nFlags:\n  -h, --help                        Show context-sensitive help.\n      --listen=\"localhost:9999\"     Server listen address ($ZM_LISTEN)\n      --accept-proxy                Accept PROXY protocol ($ZM_ACCEPT_PROXY)\n      --proxy-header-timeout=10s    Timeout for PROXY headers ($ZM_PROXY_HEADER_TIMEOUT)\n  -p, --htpasswd=FILE               Passwords file (bcrypt only) ($ZM_HTPASSWD)\n  -z, --zone=FILE,...               Zone files to update ($ZM_ZONE)\n      --debug                       Enable debug logging ($ZM_DEBUG)\n```\n\n\u003e [!NOTE]\n\u003e API description also available in OpenAPI 3 format on `/swagger`,\n\u003e e.g. http://localhost:9999/swagger\n\n\nPowerDNS-Compatible API\n-----------------------\n\nZone-o-matic exposes a PowerDNS-compatible API subset under `/api/v1`.\nIt is intended for clients that only need server discovery plus read/update access to existing zones,\nsuch as Proxmox SDN.\n\nAuthentication:\n\n- `X-API-Key` must contain base64-encoded `user:password`, using credentials from the htpasswd file.\n- Regular HTTP Basic Auth with the same credentials is also accepted.\n- The only server id is `localhost`.\n\nImplemented operations:\n\n- `GET /api/v1/servers`\n- `GET /api/v1/servers/localhost`\n- `GET /api/v1/servers/localhost/zones`\n- `GET /api/v1/servers/localhost/zones/{zone_id}`\n- `PATCH /api/v1/servers/localhost/zones/{zone_id}`\n\nNotes:\n\n- `PATCH` supports RRSet `REPLACE` and `DELETE` changes.\n- Zone operations work on already configured zone files only; creating new zones through the API is not supported.\n- Unsupported PowerDNS-compatible endpoints currently return `501 Not Implemented`.\n- Other PowerDNS API areas such as config, metadata, export, search, and AXFR retrieval are not implemented.\n\n`X-API-Key` example:\n\n```bash\ncurl \\\n  -H \"X-API-Key: $(printf 'user:password' | base64 -w0)\" \\\n  \"http://127.0.0.1:9999/api/v1/servers\"\n```\n\n\nGET /myip\n---------\n\nReturn client's IP Address in plain text.\n\nResponse status codes:\n\n| Code | Meaning |\n|------|---------|\n| 200 | Success |\n| 500 | Unexpected server error |\n\n\nGET /nic/update\n---------------\n\nUpdate A/AAAA records.\n\nRequired HTTP Headers:\n\n| Name | Req | Description |\n|------|-----|-------------|\n| Authorization | Yes | HTTP Basic Auth |\n\nQuery parameters:\n\n| Name | Req | Description |\n|------|-----|-------------|\n| hostname | Yes | Record name to update |\n| myip | No | IP address to set to A/AAAA |\n| myipv6 | No | IPv6 address to set to AAAA |\n| offline | No | Not supported |\n\nSee also: https://www.noip.com/integrate/request\n\n\u003e [!NOTE]\n\u003e If no `myip` nor `myipv6` provided, a client IP would be used.\n\nResponse status codes:\n\n| Code | Meaning |\n|------|---------|\n| 200 | Updated |\n| 400 | Bad request (e.g. missing `hostname`, invalid IP) |\n| 401 | Unauthorized |\n| 404 | Zone not found |\n| 500 | Unexpected server error |\n\n\nPOST /acme/update\n-----------------\n\nUpdate ACME DNS TXT records.\n\nRequired HTTP Headers:\n\n| Name | Req | Description |\n|------|-----|-------------|\n| X-Api-User | Yes* | Username from the htpasswd file |\n| X-Api-Key | Yes* | Password from the htpasswd file |\n| Authorization | Yes* | HTTP Basic Auth, alternative to pair above |\n\nJSON Object fields:\n\n| Name | Req | Description | Example |\n|------|-----|-------------|---------|\n| subdomain | Yes | Record name without `_acme-challenge.`, *not a UUID* | `foo.example.com` |\n| txt | Yes | Validation token content for the TXT record | `SomeRandomToken` |\n\nSee also: https://github.com/joohoi/acme-dns\n\n\u003e [!NOTE]\n\u003e Original ACME-DNS uses `X-Api-User`/`X-Api-Key` style authentication and typically a\n\u003e per-record API key + CNAME alias flow.\n\u003e This implementation additionally accepts HTTP Basic Auth for simplicity.\n\n\u003e [!NOTE]\n\u003e For `acme.sh` option `ACMEDNS_BASE_URL` should be like that: `https://nsapi.example.com/acme`,\n\u003e `ACMEDNS_USERNAME` \u0026 `ACMEDNS_PASSWORD` - valid user in htpasswd file,\n\u003e `ACMEDNS_SUBDOMAIN` - base domain name for which you are requesting certificate.\n\nAuth examples:\n\n`Authorization: Basic ...` mode:\n\n```bash\ncurl -u \"user:password\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"subdomain\":\"foo.example.com\",\"txt\":\"SomeRandomToken\"}' \\\n  \"http://127.0.0.1:9999/acme/update\"\n```\n\n`X-Api-User`/`X-Api-Key` mode:\n\n```bash\ncurl \\\n  -H \"X-Api-User: user\" \\\n  -H \"X-Api-Key: password\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"subdomain\":\"foo.example.com\",\"txt\":\"SomeRandomToken\"}' \\\n  \"http://127.0.0.1:9999/acme/update\"\n```\n\nResponse status codes:\n\n| Code | Meaning |\n|------|---------|\n| 200 | Updated |\n| 400 | Bad request |\n| 401 | Unauthorized |\n| 404 | Zone not found |\n| 500 | Unexpected server error |\n\n\nPOST /present\n-------------\n\nUpdate ACME DNS TXT record, in LEGO HTTP-request format.\n\nRequired HTTP Headers:\n\n| Name | Req | Description |\n|------|-----|-------------|\n| Authorization | Yes | HTTP Basic Auth |\n\nJSON Object fields:\n\n| Name | Req | Description | Example |\n|------|-----|-------------|---------|\n| fqdn | Yes | Record name without `_acme-challenge.` | `foo.example.com` |\n| value | Yes | Validation token content for the TXT record | `SomeRandomToken` |\n\nSee also: https://go-acme.github.io/lego/dns/httpreq/\n\n\u003e [!NOTE]\n\u003e Only HTTPREQ_MODE=default is supported\n\nResponse status codes:\n\n| Code | Meaning |\n|------|---------|\n| 200 | Updated |\n| 400 | Bad request |\n| 401 | Unauthorized |\n| 404 | Zone not found |\n| 500 | Unexpected server error |\n\n\nPOST /cleanup\n-------------\n\nRemove ACME DNS TXT record, in LEGO HTTP-request format.\n\nRequired HTTP Headers:\n\n| Name | Req | Description |\n|------|-----|-------------|\n| Authorization | Yes | HTTP Basic Auth |\n\nJSON Object fields:\n\n| Name | Req | Description | Example |\n|------|-----|-------------|---------|\n| fqdn | Yes | Record name without `_acme-challenge.` | `foo.example.com` |\n| value | No | Validation token content for the TXT record, Ignored | `SomeRandomToken` |\n\nSee also: https://go-acme.github.io/lego/dns/httpreq/\n\nResponse status codes:\n\n| Code | Meaning |\n|------|---------|\n| 200 | Updated |\n| 400 | Bad request |\n| 401 | Unauthorized |\n| 404 | Zone not found |\n| 500 | Unexpected server error |\n\n\nPOST /zm/update\n---------------\n\nCustom Zone-o-matic call.\nAllow to update any existing record(s).\nMatch records by FQDN and type, then each value will be translated to a record.\n\nRequired HTTP Headers:\n\n| Name | Req | Description |\n|------|-----|-------------|\n| Authorization | Yes | HTTP Basic Auth |\n\nJSON Object fields:\n\n| Name | Req | Description | Example |\n|------|-----|-------------|---------|\n| fqdn | Yes | Record domain name. | `foo.example.com` |\n| type | Yes | Record type, case-insensitive. | `NS` |\n| values | Yes | List of records values | `[\"ns1\", \"ns2\"]` |\n\n\u003e [!NOTE]\n\u003e `POST /zm/update` updates existing records only. If no matching record exists, it returns an error.\n\nResponse status codes:\n\n| Code | Meaning |\n|------|---------|\n| 200 | Updated |\n| 400 | Bad request |\n| 401 | Unauthorized |\n| 404 | Zone not found |\n| 500 | Unexpected server error |\n\n\nGET /health\n-----------\n\nHealth check endpoint.\n\nResponse status codes:\n\n| Code | Meaning |\n|------|---------|\n| 200 | Healthy |\n\n\ndnsfmt behavior\n---------------\n\n- Multi-part `TXT` records are kept in parenthesized multiline form.\n- `TLSA` records are kept on a single line.\n\n\n[ddns]: https://openwrt.org/docs/guide-user/services/ddns/client\n[acmesh]: https://openwrt.org/docs/guide-user/services/tls/acmesh\n[legohttp]: https://go-acme.github.io/lego/dns/httpreq/\n[owrtpkg]: https://github.com/vooon/my-openwrt-feed/tree/master/zoneomatic\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvooon%2Fzoneomatic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvooon%2Fzoneomatic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvooon%2Fzoneomatic/lists"}