Deployment facts for clients.

GET

/v1/meta

const url = 'https://api.opdns.io/v1/meta';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Environment, binary version, resolver name and dashboard origin. Cacheable for five minutes (Cache-Control: public, max-age=300); changes only on deploy.

Responses

200

Meta.

application/json

object

env

required

string

Allowed values: dev prod

version

required

string

dns_domain

required

Resolver name; profiles are <id>.<dns_domain> and https://<dns_domain>/<id>.

string

dashboard_origin

required

Dashboard origin, empty when not configured.

string

api_version

required

info.version of the API document this server implements (also the X-Opdns-Api-Version header).

string

geoip_attribution

required

Notice the GeoIP database’s licence asks to show next to country data (destinations); empty when none.

string

Example

{
  "env": "dev",
  "dns_domain": "dns.opdns.net"
}

429

Rate limited (rate_limited).

application/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 invalid_credentials signup_closed invite_required waitlist_unavailable invalid_token token_expired token_used session_required insufficient_scope csrf_rejected not_found version_mismatch ip_conflict 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 second_factor_required invalid_second_factor mfa_enrolment_required mfa_required reauth_required no_second_factor totp_already_enabled totp_not_enabled last_credential passkey_exists passkey_invalid passkeys_unavailable ceremony_invalid account_pending_deletion credential_required deletion_pending no_deletion_pending deletion_started organisation_has_members export_in_progress export_not_ready block_exists invalid_recovery_code profile_not_empty invalid_cursor bad_idempotency_key idempotency_key_reused idempotency_in_progress too_many_streams too_many_reports password_too_short password_too_long profile_suspended

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

Example

{
  "type": "https://opdns.io/problems/rate_limited",
  "title": "Too Many Requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "too many requests",
  "request_id": "5f2c9a0e7b1d4c38",
  "retry_after": 6
}

Headers

Retry-After

integer