The list compiler's sources and their last fetch (admin).

GET

/v1/admin/lists/sources

const url = 'https://api.opdns.io/v1/admin/lists/sources';
const options = {method: 'GET', headers: {cookie: 'opdns_session=<opdns_session>'}};

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/admin/lists/sources \
  --cookie opdns_session=<opdns_session>

Scope admin. Every source the list compiler runs or ran (list_sources), by id: configuration, licence and attribution, the last fetch attempt (time, HTTP status, error, ETag, bytes, snapshot hash) and the entries the source gave the last fleet build. A source no longer configured stays with enabled false.

Authorizations

session
bearer

Responses

200

Every source.

application/json

object

sources

required

Array<object>

object

required

string

name

required

string

url

required

string

format

required

string

Allowed values: hosts domains adblock rpz csv

list_id

required

integer

<= 65535

licence

required

string

licence_url

required

string

attribution

required

string

needs_audit

required

Licence not cleared for redistribution; never in the public variant.

boolean

enabled

required

boolean

refresh_seconds

required

integer

max_age_seconds

required

integer

last_attempt_at

required

string | null format: date-time

last_success_at

required

string | null format: date-time

last_change_at

required

string | null format: date-time

last_status

required

HTTP status of the last attempt; 0 when none or not HTTP.

integer

last_error

required

string

consecutive_failures

required

integer

etag

required

string

last_modified

required

string

bytes

required

integer format: int64

snapshot_sha256

required

Hash of the last good snapshot.

string

snapshot_key

required

Object key of the kept raw snapshot (raw/), empty when not kept.

string

entries

required

integer format: int64

built_version

required

The last fleet version built with the source; 0 before the first.

integer format: int64

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "sources": [
    {
      "format": "hosts"
    }
  ]
}

401

Not authenticated.

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/unauthenticated",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthenticated",
  "detail": "authentication required",
  "request_id": "5f2c9a0e7b1d4c38"
}

403

Authenticated but not allowed: insufficient_scope, session_required, csrf_rejected, mfa_enrolment_required (restricted session), mfa_required (an operator action, or an admin-scoped token, from a session signed in with the password alone; not in dev), reauth_required (sign in again within five minutes), account_pending_deletion (the account is in its deletion cooling-off).

application/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine code.

string

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/insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "the token lacks the profiles:write scope",
  "request_id": "5f2c9a0e7b1d4c38"
}