const url = ' https://api.opdns.io/v1/auth/me/export ' ;
headers: {cookie: ' __Host-opdns_session=<__Host-opdns_session> ' }
const response = await fetch ( url , options );
const data = await response . json ();
--url https://api.opdns.io/v1/auth/me/export \
--cookie __Host-opdns_session=<__Host-opdns_session>
Needs a sign-in within the last five minutes. The archive is built in the
background: a zip with README.md, manifest.json,
account.json, sessions.json, tokens.json (metadata only),
audit_log.ndjson, the CSV tables profiles.csv, rules.csv, devices.csv
and logs_summary.csv and, per profile, profiles/<id>/profile.json (the
profile document a standalone node reads: opdns-node import-export installs
it), metadata.json, rules.json, linked_ips.json, devices.json,
nodes.json and logs.csv (cloud query logs within retention, a header row
then one row per query). Format opdns-export/2. An email says when it
is ready; it is deleted 24 hours later. One export in flight
(export_in_progress) and one per day (429 rate_limited) per account.
Idempotency-Key
string
>= 1 characters <= 255 characters
Makes the POST safe to retry: a repeat with the same key and the same request
within 24 h returns the stored response (with Idempotent-Replayed: true)
without creating again. On an operation that needs a recent sign-in, a repeat
needs one too (reauth_required). 1 to 255 visible ASCII characters (a UUID is fine).
Media type application/json
object object string
Allowed values: pending running ready failed expired
error
Why the last attempt failed.
string
string | null format: date-time
string | null format: date-time
When a ready archive is deleted (24 hours after it is ready).
string | null format: date-time
Set when status is ready: a presigned object-storage URL when the server
hands those out, otherwise the path of GET /v1/auth/me/export/{id}/download
on the API origin (send the session cookie).
string | null
Media type application/problem+json
object 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
retry_after
Seconds, repeating the Retry-After header (rate limits, offline nodes).
integer
limit
The plan limit a plan_limit problem hit.
object string
Allowed values: profiles linked_ips nodes queries_per_month log_retention_days api_tokens api_requests_per_minute
The plan’s value of the limit.
integer format: int64
string
Allowed values: free personal family business
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/unauthenticated " ,
"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).
Media type application/problem+json
object 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
retry_after
Seconds, repeating the Retry-After header (rate limits, offline nodes).
integer
limit
The plan limit a plan_limit problem hit.
object string
Allowed values: profiles linked_ips nodes queries_per_month log_retention_days api_tokens api_requests_per_minute
The plan’s value of the limit.
integer format: int64
string
Allowed values: free personal family business
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/insufficient_scope " ,
"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 "
Media type application/problem+json
object 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
retry_after
Seconds, repeating the Retry-After header (rate limits, offline nodes).
integer
limit
The plan limit a plan_limit problem hit.
object string
Allowed values: profiles linked_ips nodes queries_per_month log_retention_days api_tokens api_requests_per_minute
The plan’s value of the limit.
integer format: int64
string
Allowed values: free personal family business
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/export_in_progress " ,
"code" : " export_in_progress " ,
"detail" : " Your data export is already being prepared. We'll email you when it's ready. " ,
"request_id" : " 5f2c9a0e7b1d4c38 "
Rate limited (rate_limited). For an API token, the organisation’s plan rate is spent until RateLimit-Reset.
Media type application/problem+json
object 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
retry_after
Seconds, repeating the Retry-After header (rate limits, offline nodes).
integer
limit
The plan limit a plan_limit problem hit.
object string
Allowed values: profiles linked_ips nodes queries_per_month log_retention_days api_tokens api_requests_per_minute
The plan’s value of the limit.
integer format: int64
string
Allowed values: free personal family business
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 " ,
"detail" : " Too many requests in a short time. Please wait a moment, then try again. " ,
"request_id" : " 5f2c9a0e7b1d4c38 " ,
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.
not_implemented (cloud log queries not configured on this server) or shape_unsupported (node too old).
Media type application/problem+json
object 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
retry_after
Seconds, repeating the Retry-After header (rate limits, offline nodes).
integer
limit
The plan limit a plan_limit problem hit.
object string
Allowed values: profiles linked_ips nodes queries_per_month log_retention_days api_tokens api_requests_per_minute
The plan’s value of the limit.
integer format: int64
string
Allowed values: free personal family business
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/not_implemented " ,
"title" : " Not Implemented " ,
"code" : " not_implemented " ,
"detail" : " Query logs aren't available on this server, so there is nothing to show here. " ,
"request_id" : " 5f2c9a0e7b1d4c38 "