Generate the profile's block page certificate.
const url = 'https://api.opdns.io/v1/profiles/example/block-page/ca';const options = { method: 'POST', headers: {cookie: '__Host-opdns_session=<__Host-opdns_session>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.opdns.io/v1/profiles/example/block-page/ca \ --cookie __Host-opdns_session=<__Host-opdns_session>Token scope: profiles:write. Generates a certificate authority for this
profile’s block page: an ECDSA P-256 CA valid two years, path
length 0. opdns keeps its key encrypted and gives it only to its resolvers,
which use it to issue one-hour certificates for names this profile blocked
in the last minute, never for a name that resolves. A device that trusts it
would accept any certificate signed with it, so install it only on devices
you manage. Bumps the profile version (the document carries the
certificate). 409 block_page_ca_exists when the profile already has one:
revoke it first. A session needs a sign-in within the last five minutes
(reauth_required).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Public 6-character id; never 000000.
Responses
Section titled “Responses”Generated.
A profile’s block page certificate authority. The key is never returned.
object
SHA-256 of the certificate (DER), lower-case hex, to compare with what a device shows.
The certificate’s common name, as devices list it (opdns block page (<profile id>)).
When the certificate expires (two years after it was generated).
Examplegenerated
{ "fingerprint": "example", "subject": "example", "created_at": "2026-04-15T12:00:00Z", "not_after": "2026-04-15T12:00:00Z"}Headers
Section titled “Headers”Profile version as a strong ETag, e.g. "3".
Not authenticated.
object
Stable machine code.
object
Seconds, repeating the Retry-After header (rate limits, offline nodes).
The plan limit a plan_limit problem hit.
object
The plan’s value of the limit.
Where to move to a larger plan.
The scope the API token lacked (insufficient_scope).
Example
{ "type": "https://opdns.io/problems/unauthenticated", "title": "Unauthorized", "status": 401, "code": "unauthenticated", "detail": "You're not signed in, or your sign-in has ended. Please sign in again to continue.", "request_id": "5f2c9a0e7b1d4c38"}Authenticated but not allowed: insufficient_scope, session_required, csrf_rejected, reauth_required (sign in again within five minutes), account_pending_deletion (the account is in its deletion cooling-off), email_unverified (creating a profile before the email address is verified).
object
Stable machine code.
object
Seconds, repeating the Retry-After header (rate limits, offline nodes).
The plan limit a plan_limit problem hit.
object
The plan’s value of the limit.
Where to move to a larger plan.
The scope the API token lacked (insufficient_scope).
Example
{ "type": "https://opdns.io/problems/insufficient_scope", "title": "Forbidden", "status": 403, "code": "insufficient_scope", "detail": "This API token isn't allowed to do this: it needs the profiles:write scope. Create a token that includes it, then try again.", "required_scope": "profiles:write", "request_id": "5f2c9a0e7b1d4c38"}Not found (also for resources of another organisation).
object
Stable machine code.
object
Seconds, repeating the Retry-After header (rate limits, offline nodes).
The plan limit a plan_limit problem hit.
object
The plan’s value of the limit.
Where to move to a larger plan.
The scope the API token lacked (insufficient_scope).
Example
{ "type": "https://opdns.io/problems/not_found", "title": "Not Found", "status": 404, "code": "not_found", "detail": "We couldn't find that. It may have been deleted, or the link may be wrong.", "request_id": "5f2c9a0e7b1d4c38"}The profile already has a block page certificate (block_page_ca_exists), or it is suspended (profile_suspended).
object
Stable machine code.
object
Seconds, repeating the Retry-After header (rate limits, offline nodes).
The plan limit a plan_limit problem hit.
object
The plan’s value of the limit.
Where to move to a larger plan.
The scope the API token lacked (insufficient_scope).
Example
{ "type": "https://opdns.io/problems/block_page_ca_exists", "title": "Conflict", "status": 409, "code": "block_page_ca_exists", "detail": "This profile already has a block page certificate. Revoke it before creating a new one.", "request_id": "5f2c9a0e7b1d4c38"}