DNS API documentation
Gets account limits
Código | Descripción |
---|
200 | Account limits info |
Lists devices
Código | Descripción |
---|
200 | List of devices |
POST
Creates a new device
Código | Descripción |
---|
200 | Device created |
400 | Validación fallida |
429 | Devices count reached the limit |
Removes a device
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
device_id | path | | Sí | linha |
Código | Descripción |
---|
200 | Device deleted |
404 | Dispositivo no encontrado |
Gets an existing device by ID
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
device_id | path | | Sí | string |
Código | Descripción |
---|
200 | Device info |
404 | Dispositivo no encontrado |
Actualiza un dispositivo existente
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
device_id | path | | Sí | string |
Código | Descripción |
---|
200 | Dispositivo actualizado |
400 | Validación fallida |
404 | Dispositivo no encontrado |
Obtiene el archivo DNS-over-HTTPS .mobileconfig.
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
device_id | path | | Sí | string |
exclude_wifi_networks | consulta | Enumera las redes Wi-Fi por su SSID, en las que deseas deshabilitar AdGuard DNS | No | [ linha ] |
exclude_domain | consulta | Enumera los dominios que usarán servidores DNS predeterminados en lugar de AdGuard DNS | No | [ string ] |
Código | Descripción |
---|
200 | Archivo .plist DNS-sobre-HTTPS |
404 | Dispositivo no encontrado |
Obtiene el archivo .mobileconfig de DNS-over-TLS.
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
device_id | path | | Sí | linha |
exclude_wifi_networks | consulta | Enumera las redes Wi-Fi por su SSID, en las que deseas deshabilitar AdGuard DNS | No | [ linha ] |
exclude_domain | consulta | Enumera los dominios que usarán servidores DNS predeterminados en lugar de AdGuard DNS | No | [ linha ] |
Código | Descripción |
---|
200 | Archivo .plist DNS-sobre-HTTPS |
404 | Dispositivo no encontrado |
Actualiza la configuración del dispositivo
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
device_id | path | | Sí | linha |
Código | Descripción |
---|
200 | Configuración del dispositivo actualizada |
400 | Validación fallida |
404 | Dispositivo no encontrado |
Lists DNS servers that belong to the user.
Lists DNS servers that belong to the user. De forma predeterminada, hay al menos un servidor predeterminado.
Código | Descripción |
---|
200 | List of DNS servers |
POST
Crea un nuevo servidor DNS
Crea un nuevo servidor DNS. Puedes adjuntar configuraciones personalizadas; de lo contrario, el servidor DNS se creará con la configuración predeterminada.
Código | Descripción |
---|
200 | DNS server created |
400 | Validación fallida |
429 | DNS servers count reached the limit |
Removes a DNS server
Removes a DNS server. All devices attached to this DNS server will be moved to the default DNS server. Deleting a default DNS server is forbidden.
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
dns_server_id | path | | Sí | string |
Código | Descripción |
---|
200 | DNS server deleted |
404 | Servidor DNS no encontrado |
Gets an existing DNS server by ID
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
dns_server_id | path | | Sí | string |
Código | Descripción |
---|
200 | Información del servidor DNS |
404 | Servidor DNS no encontrado |
Updates an existing DNS server
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
dns_server_id | path | | Sí | string |
Código | Descripción |
---|
200 | Servidor DNS actualizado |
400 | Validación fallida |
404 | Servidor DNS no encontrado |
Actualiza la configuración del servidor DNS
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
dns_server_id | path | | Sí | string |
Código | Descripción |
---|
200 | Configuración del servidor DNS actualizada |
400 | Validación fallida |
404 | Servidor DNS no encontrado |
Obtiene listas de filtros
Código | Descripción |
---|
200 | Lista de filtros |
POST
Genera un token de Acceso y Actualización
Código | Descripción |
---|
200 | Access token issued |
400 | Missing required parameters |
401 | Invalid credentials, MFA token or refresh token provided |
null
Clears query log
Código | Descripción |
---|
202 | Query log was cleared |
Gets query log
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
time_from_millis | consulta | Time from in milliseconds (inclusive) | Sí | long |
time_to_millis | consulta | Time to in milliseconds (inclusive) | Sí | long |
devices | consulta | Filter by devices | No | [ string ] |
countries | consulta | Filter by countries | No | [ string ] |
companies | consulta | Filter by companies | No | [ string ] |
statuses | consulta | Filter by statuses | No | [ FilteringActionStatus ] |
categories | consulta | Filter by categories | No | [ CategoryType ] |
search | consulta | Filtrar por nombre de dominio | No | string |
limit | consulta | Limit the number of records to be returned | No | integer |
cursor | consulta | Pagination cursor. Use cursor from response to paginate through the pages. | No | string |
Código | Descripción |
---|
200 | Query log |
POST
Revokes a Refresh Token
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
refresh_token | consulta | Refresh Token | Sí | string |
Código | Descripción |
---|
200 | Refresh token revoked |
null
Gets categories statistics
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
time_from_millis | consulta | Time from in milliseconds (inclusive) | Sí | long |
time_to_millis | consulta | Time to in milliseconds (inclusive) | Sí | long |
devices | consulta | Filter by devices | No | [ string ] |
countries | consulta | Filter by countries | No | [ string ] |
Código | Descripción |
---|
200 | Categories statistics received |
400 | Validación fallida |
Gets companies statistics
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
time_from_millis | consulta | Time from in milliseconds (inclusive) | Sí | long |
time_to_millis | consulta | Time to in milliseconds (inclusive) | Sí | long |
devices | consulta | Filter by devices | No | [ string ] |
countries | consulta | Filter by countries | No | [ string ] |
Código | Descripción |
---|
200 | Companies statistics received |
400 | Validación fallida |
Gets detailed companies statistics
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
time_from_millis | consulta | Time from in milliseconds (inclusive) | Sí | long |
time_to_millis | consulta | Time to in milliseconds (inclusive) | Sí | long |
devices | consulta | Filter by devices | No | [ string ] |
countries | consulta | Filter by countries | No | [ string ] |
cursor | consulta | Pagination cursor | No | string |
Código | Descripción |
---|
200 | Detailed companies statistics received |
400 | Validación fallida |
Gets countries statistics
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
time_from_millis | consulta | Time from in milliseconds (inclusive) | Sí | long |
time_to_millis | consulta | Time to in milliseconds (inclusive) | Sí | long |
devices | consulta | Filter by devices | No | [ string ] |
countries | consulta | Filter by countries | No | [ string ] |
Código | Descripción |
---|
200 | Countries statistics received |
400 | Validación fallida |
Gets devices statistics
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
time_from_millis | consulta | Time from in milliseconds (inclusive) | Sí | long |
time_to_millis | consulta | Time to in milliseconds (inclusive) | Sí | long |
devices | consulta | Filter by devices | No | [ string ] |
countries | consulta | Filter by countries | No | [ string ] |
Código | Descripción |
---|
200 | Devices statistics received |
400 | Validación fallida |
/oapi/v1/stats/domains
Gets domains statistics
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
time_from_millis | consulta | Time from in milliseconds (inclusive) | Sí | long |
time_to_millis | consulta | Time to in milliseconds (inclusive) | Sí | long |
devices | consulta | Filter by devices | No | [ string ] |
countries | consulta | Filter by countries | No | [ string ] |
Código | Descripción |
---|
200 | Domains statistics received |
400 | Validación fallida |
Gets time statistics
Nombre | Ubicado en | Descripción | Requerido | Esquema |
---|
time_from_millis | consulta | Time from in milliseconds (inclusive) | Sí | long |
time_to_millis | consulta | Time to in milliseconds (inclusive) | Sí | long |
devices | consulta | Filter by devices | No | [ string ] |
countries | consulta | Filter by countries | No | [ string ] |
Código | Descripción |
---|
200 | Time statistics received |
400 | Validación fallida |
Lists web services
Código | Descripción |
---|
200 | List of web-services |