Skip to content
Log inDashboard

What this deployment supports.

GET
/v1/capabilities
curl --request GET \
--url https://api.opdns.io/v1/capabilities

Computed from the server’s configuration, the same for every caller, so the dashboard can hide or explain what this deployment cannot offer. settings is keyed by the profile Settings field names: supported, an optional reason (why the setting is unavailable) and, for enumerated settings, values: every value with its own supported and reason (block_mode block-page is supported only where the block page host runs; node_queue_hours lists 0, 1, 12 and 24, keyed as strings; log_region lists ca, supported, and eu, unsupported with the reason that it is coming soon). A setting missing from settings is not offered. features: destinations_map when destinations rows carry countries (a GeoIP database is configured), list_reports when list reports are accepted, apple_profile_signature how the GET /v1/setup/apple profile is signed now (unsigned, untrusted or verified). Anything that depends on a profile (its node, its plan) is not here.

Capabilities.

Media typeapplication/json
object
settings
required

Keyed by the profile Settings field names, and by security.<field> for the Security toggles. security.idn_homograph, security.typosquat and security.dga are unsupported until the resolvers implement them: new profiles have them off and a stored true has no effect.

object
key
additional properties
object
supported
required
boolean
reason

Why the setting is not available here.

string
values

Enumerated settings only, keyed by value.

object
key
additional properties
object
supported
required
boolean
reason

Why the value is not available, or a caveat.

string
features
required
object
destinations_map
required

destinations rows carry country (a GeoIP database is configured).

boolean
list_reports
required

POST /v1/profiles/{id}/list-reports is available.

boolean
apple_profile_signature
required

How the configuration profile of GET /v1/setup/apple is signed now: unsigned (no signing certificate: iOS and macOS label it “Unverified”), untrusted (signed with a certificate that does not chain to a public root, as in a local test deployment: still “Unverified”) or verified (signed with a publicly trusted certificate: “Verified”).

string
Allowed values: unsigned untrusted verified
Example
{
"features": {
"apple_profile_signature": "unsigned"
}
}

Rate limited (rate_limited). For an API token, the organisation’s plan rate is spent until RateLimit-Reset.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
code
required

Stable machine code.

string
Allowed values: bad_request body_too_large bad_if_match unauthenticated signup_closed invite_required waitlist_unavailable mail_unavailable invalid_token token_expired token_used email_unverified session_required insufficient_scope csrf_rejected not_found version_mismatch ip_conflict managed_by_opwan no_opdns_account service_unavailable unknown_list too_many_rules validation_failed rate_limited internal node_revoked node_offline node_busy node_timeout node_error result_too_large shape_unsupported node_token_superseded relay_unavailable not_implemented query_timeout query_too_expensive range_too_large too_many_queries mfa_required reauth_required account_pending_deletion deletion_pending no_deletion_pending deletion_started organisation_has_members export_in_progress export_not_ready block_exists profile_not_empty no_adoption_pending invalid_cursor bad_idempotency_key idempotency_key_reused idempotency_in_progress too_many_streams too_many_reports profile_suspended plan_limit owner_required billing_unavailable billing_provider_error subscription_exists no_billing_account block_page_ca_exists oidc_unavailable feedback_status_conflict reply_not_wanted reply_unavailable
detail
string
errors
Array<object>
object
field
required
string
message
required
string
request_id
string
retry_after

Seconds, repeating the Retry-After header (rate limits, offline nodes).

integer
limit

The plan limit a plan_limit problem hit.

object
name
required
string
Allowed values: profiles linked_ips nodes queries_per_month log_retention_days api_tokens api_requests_per_minute
max
required

The plan’s value of the limit.

integer format: int64
plan
required
string
Allowed values: free personal family business
upgrade_url
required

Where to move to a larger plan.

string format: uri
required_scope

The scope the API token lacked (insufficient_scope).

string
Allowed values: profiles:read profiles:write nodes:write account:read billing:read logs:read analytics:read
Example
{
"type": "https://opdns.io/problems/rate_limited",
"title": "Too Many Requests",
"status": 429,
"code": "rate_limited",
"detail": "Too many requests in a short time. Please wait a moment, then try again.",
"request_id": "5f2c9a0e7b1d4c38",
"retry_after": 6
}
Retry-After
integer
RateLimit-Limit
integer
>= 1

On every response to an API token: the organisation’s plan rate, requests per one-minute window (api_requests_per_minute).

RateLimit-Remaining
integer

On every response to an API token: the requests left to the organisation in the current window.

RateLimit-Reset
integer

On every response to an API token: seconds until the current window ends and the count resets.

RateLimit-Policy
string

On every response to an API token: the quota policy, <limit>;w=60.