Skip to content
op
dns
docs
Search the docs
Ctrl
K
Cancel
Pricing
Status
Log in
Dashboard
Menu
Get started
What op
dns
is
Create an account and a profile
Your endpoints
Check it works
Set up a device
Android
iOS and iPadOS
macOS
Windows 11
Linux (systemd-resolved)
ChromeOS
Tested clients
Block page and its certificate
Browsers
Firefox
Chrome
Edge
Brave
Set up a network
OpenWrt
pfSense and OPNsense
UniFi
MikroTik (RouterOS)
Asus (Asuswrt-Merlin)
Any router (DHCP and IPv6)
Linked IP and DDNS
Dashboard guide
Profiles
Security
Privacy blocklists
Parental control
Denylist, allowlist and rewrites
Settings
Logs
Analytics
Devices
Nodes
Account
Features
Web3 names
Self-hosted node
Overview
Install with Docker
Install the static binary
Enrol a node
Standalone mode
Network access
Configuration reference
Logs on your node
Offline behaviour and troubleshooting
Upgrade and back up
Privacy
How it works
Architecture and the log model
Identification
Policy evaluation order
Block answers and EDE codes
The public resolver path
Our network
API
Authentication, tokens and scopes
Errors and rate limits
API versioning
API changelog
Reference
Overview
auth
Overview
Read the current public signup mode.
GET
Request a waitlist confirmation email.
POST
Confirm a waitlist email address.
POST
Sign in with your op account (OIDC).
GET
opauth's redirect back after a sign-in (OIDC callback).
GET
End the current session.
POST
The authenticated account.
GET
The account's recent data exports, newest first (session only).
GET
Start an export of the account's data (session only).
POST
An export's status and, when ready, its download URL (session only).
GET
Download a ready export archive (session only).
GET
The current terms of service version and the account's acceptance.
GET
Accept the current terms of service (session only).
POST
The account's preferences, defaults filled in (session only).
GET
Change preferences (session only).
PATCH
The organisation's audit log, newest first.
GET
account
Overview
The organisation's plan, its limits and this month's usage.
GET
billing
Overview
The organisation's billing state.
GET
Start a Stripe Checkout to upgrade.
POST
Open Stripe's customer portal.
POST
Stripe's webhook.
POST
tokens
Overview
List API tokens of the account.
GET
Create an API token (session only).
POST
Revoke an API token (session only).
DELETE
Leaked-token alerts from GitHub secret scanning.
POST
profiles
Overview
List the organisation's profiles.
GET
Create a profile.
POST
Get a profile.
GET
Delete a profile.
DELETE
Update name and settings (partial).
PATCH
Deny, allow and rewrite rules.
GET
Replace every rule (one version bump).
PUT
Enabled catalogue lists.
GET
Set the enabled lists.
PUT
Linked IPv4 addresses (Do53 identification).
GET
Link an address, or create an empty DDNS slot.
POST
Unlink an address.
DELETE
The profile's block page certificate, if it has one.
GET
Generate the profile's block page certificate.
POST
Revoke the profile's block page certificate.
DELETE
Download the block page certificate (PEM).
GET
Download the block page certificate (DER, Windows and Android).
GET
Download the block page certificate for iOS and macOS.
GET
lists
Overview
The blocklist catalogue with sources and licences.
GET
Parental-control categories a profile can block (parental.categories).
GET
Blockable services (parental.services) with their domains and collateral-damage notes.
GET
The profile's list reports, newest first.
GET
Report a list false positive or false negative.
POST
nodes
Overview
Self-hosted nodes of the profile.
GET
Create a node and its one-time enrolment code.
POST
Revoke a node.
DELETE
Decide about a standalone node's held local profile.
POST
Exchange an enrolment code for a node token (node side).
POST
The calling node's identity (node side).
GET
Revoke the calling node (node side, `op
dns
-node unenrol`).
DELETE
Rotate the calling node's token (node side, `op
dns
-node rotate-token`).
POST
The calling node's profile document (node side).
GET
A short-lived download URL of the list artifact the calling node should load (node side).
GET
devices
Overview
List the profile's devices.
GET
Get one device.
GET
Forget a device.
DELETE
Set a device's display name, kind or notes.
PATCH
logs
Overview
Query log tail or search.
GET
Live log tail as server-sent events.
GET
Analytics aggregate.
GET
ddns
Overview
The DDNS update URL of a linked IP.
GET
Replace the DDNS token; the old URL stops working at once.
POST
Set the linked IP owning the token to the caller's IPv4 address.
GET
meta
Overview
This document.
GET
This document, as JSON.
GET
Deployment facts for clients.
GET
What this deployment supports.
GET
The PoP catalogue.
GET
The caller's public IP address as the API sees it.
GET
Report a dashboard error.
POST
Send feedback from the dashboard.
POST
data-rights
Overview
The account's recent data exports, newest first (session only).
GET
Start an export of the account's data (session only).
POST
An export's status and, when ready, its download URL (session only).
GET
Download a ready export archive (session only).
GET
setup
Overview
Setup values or an Apple configuration profile for a profile.
GET
op
dns
compared with NextDNS and ControlD
Operator (admin only)
Operator and source blocks
List rollouts
Profile propagation
Resolver operations
Fleet operations
Backups and restore
Alerting
GeoIP and owner classification
Admin tools
Legal and project
Licensing
Self-hosted licence FAQ
Attributions
Policies
Privacy policy
Sub-processors
Terms of service
Acceptable use policy
Your data rights
Operator blocks and takedowns
Security policy
Reporting abuse
Law-enforcement guidelines
Support and contact
Changelog
Service status
Pricing
Status
Overview
tokens
Section titled “tokens”
API tokens and their scopes.
Operations
Section titled “Operations”
GET
/v1/tokens
POST
/v1/tokens
DELETE
/v1/tokens/{id}
POST
/v1/webhooks/token-leak
Home
Pricing
Status
Private alpha, live now, by invitation. Public beta later in 2026.