Skip to main content

Referencia

This article contains documentation for AdGuard DNS API. For the complete AdGuard DNS API changelog, visit this page.

Current version: 1.8

/oapi/v1/account/limits

GET

Summary

Gets account limits

Respuestas
CódigoDescripción
200Account limits info

/oapi/v1/devices

GET

Summary

Lists devices

Respuestas
CódigoDescripción
200List of devices

POST

Summary

Creates a new device

Respuestas
CódigoDescripción
200Device created
400Validación fallida
429Devices count reached the limit

/oapi/v1/devices/{device_id}

DELETE

Summary

Removes a device

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
device_idpathlinha
Respuestas
CódigoDescripción
200Device deleted
404Dispositivo no encontrado

GET

Summary

Gets an existing device by ID

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
device_idpathstring
Respuestas
CódigoDescripción
200Device info
404Dispositivo no encontrado

PUT

Summary

Actualiza un dispositivo existente

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
device_idpathstring
Respuestas
CódigoDescripción
200Dispositivo actualizado
400Validación fallida
404Dispositivo no encontrado

/oapi/v1/devices/{device_id}/doh.mobileconfig

GET

Summary

Obtiene el archivo DNS-over-HTTPS .mobileconfig.

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
device_idpathstring
exclude_wifi_networksconsultaEnumera las redes Wi-Fi por su SSID, en las que deseas deshabilitar AdGuard DNSNo[ linha ]
exclude_domainconsultaEnumera los dominios que usarán servidores DNS predeterminados en lugar de AdGuard DNSNo[ string ]
Respuestas
CódigoDescripción
200Archivo .plist DNS-sobre-HTTPS
404Dispositivo no encontrado

/oapi/v1/devices/{device_id}/dot.mobileconfig

GET

Summary

Obtiene el archivo .mobileconfig de DNS-over-TLS.

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
device_idpathlinha
exclude_wifi_networksconsultaEnumera las redes Wi-Fi por su SSID, en las que deseas deshabilitar AdGuard DNSNo[ linha ]
exclude_domainconsultaEnumera los dominios que usarán servidores DNS predeterminados en lugar de AdGuard DNSNo[ linha ]
Respuestas
CódigoDescripción
200Archivo .plist DNS-sobre-HTTPS
404Dispositivo no encontrado

/oapi/v1/devices/{device_id}/settings

PUT

Summary

Actualiza la configuración del dispositivo

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
device_idpathlinha
Respuestas
CódigoDescripción
200Configuración del dispositivo actualizada
400Validación fallida
404Dispositivo no encontrado

/oapi/v1/dns_servers

GET

Summary

Lists DNS servers that belong to the user.

Descripción

Lists DNS servers that belong to the user. By default there is at least one default server.

Respuestas
CódigoDescripción
200List of DNS servers

POST

Summary

Crea un nuevo servidor DNS

Descripción

Crea un nuevo servidor DNS. Puedes adjuntar configuraciones personalizadas; de lo contrario, el servidor DNS se creará con la configuración predeterminada.

Respuestas
CódigoDescripción
200DNS server created
400Validación fallida
429DNS servers count reached the limit

/oapi/v1/dns_servers/{dns_server_id}

DELETE

Summary

Removes a DNS server

Descripción

Removes a DNS server. All devices attached to this DNS server will be moved to the default DNS server. Deleting the default DNS server is forbidden.

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
dns_server_idpathstring
Respuestas
CódigoDescripción
200DNS server deleted
404Servidor DNS no encontrado

OBTENER

Summary

Gets an existing DNS server by ID

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
dns_server_idpathstring
Respuestas
CódigoDescripción
200Información del servidor DNS
404Servidor DNS no encontrado

PUT

Summary

Updates an existing DNS server

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
dns_server_idpathstring
Respuestas
CódigoDescripción
200Servidor DNS actualizado
400Validación fallida
404Servidor DNS no encontrado

/oapi/v1/dns_servers/{dns_server_id}/settings

PUT

Summary

Actualiza la configuración del servidor DNS

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
dns_server_idpathstring
Respuestas
CódigoDescripción
200Configuración del servidor DNS actualizada
400Validación fallida
404Servidor DNS no encontrado

/oapi/v1/filter_lists

OBTENER

Summary

Obtiene listas de filtros

Respuestas
CódigoDescripción
200Lista de filtros

/oapi/v1/oauth_token

POST

Summary

Genera un token de Acceso y Actualización

Respuestas
CódigoDescripción
200Access token issued
400Missing required parameters
401Invalid credentials, MFA token or refresh token provided

/oapi/v1/query_log

DELETE

Summary

Clears query log

Respuestas
CódigoDescripción
202Query log was cleared

OBTENER

Summary

Gets query log

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
time_from_millisconsultaTime from in milliseconds (inclusive)long
time_to_millisconsultaTime to in milliseconds (inclusive)long
devicesconsultaFilter by devicesNo[ string ]
countriesconsultaFilter by countriesNo[ string ]
companiesconsultaFilter by companiesNo[ string ]
statusesconsultaFilter by statusesNo[ FilteringActionStatus ]
categoriesconsultaFilter by categoriesNo[ CategoryType ]
searchconsultaFiltrar por nombre de dominioNostring
limitconsultaLimit the number of records to be returnedNointeger
cursorconsultaPagination cursor. Use cursor from response to paginate through the pages.Nostring
Respuestas
CódigoDescripción
200Query log

/oapi/v1/revoke_token

POST

Summary

Revokes a Refresh Token

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
refresh_tokenconsultaRefresh Tokenstring
Respuestas
CódigoDescripción
200Refresh token revoked

/oapi/v1/stats/categories

OBTENER

Summary

Gets categories statistics

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
time_from_millisconsultaTime from in milliseconds (inclusive)long
time_to_millisconsultaTime to in milliseconds (inclusive)long
devicesconsultaFilter by devicesNo[ string ]
countriesconsultaFilter by countriesNo[ string ]
Respuestas
CódigoDescripción
200Categories statistics received
400Validación fallida

/oapi/v1/stats/companies

GET

Summary

Gets companies statistics

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
time_from_millisconsultaTime from in milliseconds (inclusive)long
time_to_millisconsultaTime to in milliseconds (inclusive)long
devicesconsultaFilter by devicesNo[ linha ]
countriesconsultaFilter by countriesNo[ string ]
Respuestas
CódigoDescripción
200Companies statistics received
400Validación fallida

/oapi/v1/stats/companies/detailed

GET

Summary

Gets detailed companies statistics

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
time_from_millisconsultaTime from in milliseconds (inclusive)long
time_to_millisconsultaTime to in milliseconds (inclusive)long
devicesconsultaFilter by devicesNo[ linha ]
countriesconsultaFilter by countriesNo[ string ]
cursorconsultaPagination cursorNostring
Respuestas
CódigoDescripción
200Detailed companies statistics received
400Validación fallida

/oapi/v1/stats/countries

GET

Summary

Gets countries statistics

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
time_from_millisconsultaTime from in milliseconds (inclusive)long
time_to_millisconsultaTime to in milliseconds (inclusive)long
devicesconsultaFilter by devicesNo[ string ]
countriesconsultaFilter by countriesNo[ string ]
Respuestas
CódigoDescripción
200Countries statistics received
400Validación fallida

/oapi/v1/stats/devices

GET

Summary

Gets devices statistics

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
time_from_millisconsultaTime from in milliseconds (inclusive)long
time_to_millisconsultaTime to in milliseconds (inclusive)long
devicesconsultaFilter by devicesNo[ linha ]
countriesconsultaFilter by countriesNo[ string ]
Respuestas
CódigoDescripción
200Devices statistics received
400Validación fallida

/oapi/v1/stats/domains

GET

Summary

Gets domains statistics

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
time_from_millisconsultaTime from in milliseconds (inclusive)long
time_to_millisconsultaTime to in milliseconds (inclusive)long
devicesconsultaFilter by devicesNo[ linha ]
countriesconsultaFilter by countriesNo[ string ]
Respuestas
CódigoDescripción
200Domains statistics received
400Validación fallida

/oapi/v1/stats/time

GET

Summary

Gets time statistics

Parámetros
NombreUbicado enDescripciónRequeridoEsquema
time_from_millisconsultaTime from in milliseconds (inclusive)long
time_to_millisconsultaTime to in milliseconds (inclusive)long
devicesconsultaFilter by devicesNo[ linha ]
countriesconsultaFilter by countriesNo[ string ]
Respuestas
CódigoDescripción
200Time statistics received
400Validación fallida

/oapi/v1/web_services

GET

Summary

Lists web services

Respuestas
CódigoDescripción
200List of web-services