Руководство по API

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

Текущая версия: 1.9

/oapi/v1/account/limits

GET

Что делает

Gets account limits

Ответы

Код	Описание
200	Информация о лимитах аккаунта

/oapi/v1/dedicated_addresses/ipv4

GET

Что делает

Lists dedicated IPv4 addresses

Ответы

Код	Описание
200	Список выделенных IPv4-адресов

POST

Что делает

Allocates new IPv4

Ответы

Код	Описание
200	Новый IPv4 успешно выделен
429	Количество выделенных IPv4 достигло предела

/oapi/v1/devices

GET

Что делает

Lists devices

Ответы

Код	Описание
200	Список устройств

POST

Что делает

Creates a new device

Ответы

Код	Описание
200	Устройство создано
400	Ошибка проверки
429	Количество устройств достигло предела

/oapi/v1/devices/{device_id}

DELETE

Что делает

Removes a device

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
device_id	path		Да	string

Ответы

Код	Описание
200	Устройство удалено
404	Устройство не найдено

GET

Что делает

Gets an existing device by ID

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
device_id	path		Да	string

Ответы

Код	Описание
200	Информация об устройстве
404	Устройство не найдено

PUT

Что делает

Updates an existing device

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
device_id	path		Да	string

Ответы

Код	Описание
200	Устройство обновлено
400	Ошибка проверки
404	Устройство не найдено

/oapi/v1/devices/{device_id}/dedicated_addresses

GET

Что делает

List dedicated IPv4 and IPv6 addresses for a device

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
device_id	path		Да	string

Ответы

Код	Описание
200	Выделенные IPv4 и IPv6

/oapi/v1/devices/{device_id}/dedicated_addresses/ipv4

DELETE

Что делает

Unlink dedicated IPv4 from the device

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
device_id	path		Да	string

Ответы

Код	Описание
200	Выделенный IPv4 успешно отвязан от устройства
404	Устройство или адрес не найдены

POST

Что делает

Link dedicated IPv4 to the device

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
device_id	path		Да	string

Ответы

Код	Описание
200	Выделенный IPv4 успешно привязан к устройству
400	Ошибка проверки
404	Устройство или адрес не найдены
429	Количество привязанных выделенных IPv4 достигло предела

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

GET

Что делает

Gets DNS-over-HTTPS .mobileconfig file.

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
device_id	path		Да	string
exclude_wifi_networks	query	Перечислите сети Wi-Fi по их SSID, для которых вы хотите отключить AdGuard DNS	Нет	[ string ]
exclude_domain	query	Перечислите домены, которые будут использовать DNS-серверы по умолчанию вместо AdGuard DNS	Нет	[ string ]

Ответы

Код	Описание
200	Файл DNS-over-HTTPS .plist
404	Устройство не найдено

/oapi/v1/devices/{device_id}/doh_password/reset

PUT

Что делает

Generate and set new DNS-over-HTTPS password

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
device_id	path		Да	string

Ответы

Код	Описание
200	Пароль DNS-over-HTTPS успешно сброшен
404	Устройство не найдено

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

GET

Что делает

Gets DNS-over-TLS .mobileconfig file.

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
device_id	path		Да	string
exclude_wifi_networks	query	Перечислите сети Wi-Fi по их SSID, для которых вы хотите отключить AdGuard DNS	Нет	[ string ]
exclude_domain	query	Перечислите домены, которые будут использовать DNS-серверы по умолчанию вместо AdGuard DNS	Нет	[ string ]

Ответы

Код	Описание
200	Файл DNS-over-HTTPS .plist
404	Устройство не найдено

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

PUT

Что делает

Updates device settings

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
device_id	path		Да	string

Ответы

Код	Описание
200	Настройки устройства обновлены
400	Ошибка проверки
404	Устройство не найдено

/oapi/v1/dns_servers

GET

Что делает

Lists DNS servers that belong to the user.

Описание

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

Ответы

Код	Описание
200	Список DNS-серверов

POST

Что делает

Creates a new DNS server

Описание

Creates a new DNS server. You can attach custom settings, otherwise DNS server will be created with default settings.

Ответы

Код	Описание
200	DNS-сервер создан
400	Ошибка проверки
429	Количество DNS-серверов достигло предела

/oapi/v1/dns_servers/{dns_server_id}

DELETE

Что делает

Removes a DNS server

Описание

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.

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
dns_server_id	path		Да	string

Ответы

Код	Описание
200	DNS-сервер удалён
404	DNS-сервер не найден

GET

Что делает

Gets an existing DNS server by ID

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
dns_server_id	path		Да	string

Ответы

Код	Описание
200	Информация о DNS-сервере
404	DNS-сервер не найден

PUT

Что делает

Updates an existing DNS server

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
dns_server_id	path		Да	string

Ответы

Код	Описание
200	DNS-сервер обновлён
400	Ошибка проверки
404	DNS-сервер не найден

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

PUT

Что делает

Updates DNS server settings

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
dns_server_id	path		Да	string

Ответы

Код	Описание
200	Настройки DNS-сервера обновлены
400	Ошибка проверки
404	DNS-сервер не найден

/oapi/v1/filter_lists

GET

Что делает

Gets filter lists

Ответы

Код	Описание
200	Список фильтров

/oapi/v1/oauth_token

POST

Что делает

Generates Access and Refresh token

Ответы

Код	Описание
200	Выдан токен доступа
400	Отсутствуют обязательные параметры
401	Предоставлены недействительные учётные данные, токен MFA или продлеваемый токен

null

/oapi/v1/query_log

DELETE

Что делает

Clears query log

Ответы

Код	Описание
202	Журнал запросов был очищен

GET

Что делает

Gets query log

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
time_from_millis	query	Время от в миллисекундах (включительно)	Да	long
time_to_millis	query	Время до в миллисекундах (включительно)	Да	long
devices	query	Фильтровать по устройствам	Нет	[ string ]
countries	query	Фильтровать по странам	Нет	[ string ]
companies	query	Фильтровать по компаниям	Нет	[ string ]
statuses	query	Фильтровать по статусам	Нет	[ FilteringActionStatus ]
categories	query	Фильтровать по категориям	Нет	[ CategoryType ]
search	query	Фильтровать по доменному имени	Нет	string
limit	query	Ограничить количество возвращаемых записей	Нет	integer
cursor	query	Курсорная пагинация. Используйте курсор из ответа для разбивки по страницам.	Нет	string

Ответы

Код	Описание
200	Журнал запросов

/oapi/v1/revoke_token

POST

Что делает

Revokes a Refresh Token

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
refresh_token	query	Продлеваемый токен	Да	string

Ответы

Код	Описание
200	Продлеваемый токен отозван

null

/oapi/v1/stats/categories

GET

Что делает

Gets categories statistics

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
time_from_millis	query	Время от в миллисекундах (включительно)	Да	long
time_to_millis	query	Время до в миллисекундах (включительно)	Да	long
devices	query	Фильтровать по устройствам	Нет	[ string ]
countries	query	Фильтровать по странам	Нет	[ string ]

Ответы

Код	Описание
200	Получена статистика по категориям
400	Ошибка проверки

/oapi/v1/stats/companies

GET

Что делает

Gets companies statistics

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
time_from_millis	query	Время от в миллисекундах (включительно)	Да	long
time_to_millis	query	Время до в миллисекундах (включительно)	Да	long
devices	query	Фильтровать по устройствам	Нет	[ string ]
countries	query	Фильтровать по странам	Нет	[ string ]

Ответы

Код	Описание
200	Получена статистика по компаниям
400	Ошибка проверки

/oapi/v1/stats/companies/detailed

GET

Что делает

Gets detailed companies statistics

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
time_from_millis	query	Время от в миллисекундах (включительно)	Да	long
time_to_millis	query	Время до в миллисекундах (включительно)	Да	long
devices	query	Фильтровать по устройствам	Нет	[ string ]
countries	query	Фильтровать по странам	Нет	[ string ]
cursor	query	Курсорная пагинация	Нет	string

Ответы

Код	Описание
200	Получена подробная статистика по компаниям
400	Ошибка проверки

/oapi/v1/stats/countries

GET

Что делает

Gets countries statistics

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
time_from_millis	query	Время от в миллисекундах (включительно)	Да	long
time_to_millis	query	Время до в миллисекундах (включительно)	Да	long
devices	query	Фильтровать по устройствам	Нет	[ string ]
countries	query	Фильтровать по странам	Нет	[ string ]

Ответы

Код	Описание
200	Получена статистика по странам
400	Ошибка проверки

/oapi/v1/stats/devices

GET

Что делает

Gets devices statistics

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
time_from_millis	query	Время от в миллисекундах (включительно)	Да	long
time_to_millis	query	Время до в миллисекундах (включительно)	Да	long
devices	query	Фильтровать по устройствам	Нет	[ string ]
countries	query	Фильтровать по странам	Нет	[ string ]

Ответы

Код	Описание
200	Получена статистика по устройствам
400	Ошибка проверки

/oapi/v1/stats/domains

GET

Что делает

Gets domains statistics

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
time_from_millis	query	Время от в миллисекундах (включительно)	Да	long
time_to_millis	query	Время до в миллисекундах (включительно)	Да	long
devices	query	Фильтровать по устройствам	Нет	[ string ]
countries	query	Фильтровать по странам	Нет	[ string ]

Ответы

Код	Описание
200	Получена статистика по доменам
400	Ошибка проверки

/oapi/v1/stats/time

GET

Что делает

Gets time statistics

Параметры

Имя	Расположен в	Описание	Обязательно	Схема
time_from_millis	query	Время от в миллисекундах (включительно)	Да	long
time_to_millis	query	Время до в миллисекундах (включительно)	Да	long
devices	query	Фильтровать по устройствам	Нет	[ string ]
countries	query	Фильтровать по странам	Нет	[ string ]

Ответы

Код	Описание
200	Получена статистика по времени
400	Ошибка проверки

/oapi/v1/web_services

GET

Что делает

Lists web services

Ответы

Код	Описание
200	Список веб-служб