Overview
Welcome to the UK DNS Privacy Project API. This API allows you to manage authoritative DNS zones and records programmatically.
Base URL
https://dnsprivacy.org.uk
All requests must be made over HTTPS.
Data Format
- Request and response bodies are formatted in JSON.
- All timestamps are in ISO 8601 format.
- Charset is UTF-8.
Authentication
The API supports two authentication methods:
-
Bearer Token – Include in the
Authorization
header. -
API Key – Include in the query string via
?apikey=your-api-key
.
See the Authentication page for full details.
Status Codes
The API uses conventional HTTP response codes to indicate success or failure:
Code | Meaning |
---|---|
200 | OK |
201 | Created (if applicable) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
408 | Request Timeout |
500 | Internal Server Error |
First Steps
- Obtain an API key or OAuth token.
- Use
GET /domains
to list your current domains. - Use
POST /domains
to create a new zone. - Add DNS records using
POST /domains/:domain_id/records
.
Example: List Domains
curl -X GET "https://dnsprivacy.org.uk/domains?apikey=your-api-key" \
-H "accept: application/json"
Need Help?
If you’re stuck or need support:
- Check the Error Codes page
- Visit our GitHub Repository
- Join our Community Forum
Happy querying!