Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc getCustomDomainCertificate (CustomDomainCertificateRequest, CustomDomainCertificateResponse)

  dns.proto:85

  Get certificate for custom domain. This method may return the following errors: - AuthenticationFailedError: If the authentication failed. - BadRequestError: If the request is invalid: cert_name is empty or no certificate found. - NotFoundError: If the certificate was not found. - RateLimitedError: If the request was made too frequently and the client must wait before retrying.

  message CustomDomainCertificateRequest

  dns.proto:362

  • string cert_name = 1

  message CustomDomainCertificateResponse

  dns.proto:366

  • bytes certificate = 1

  • bytes private_key = 2

• rpc createDeviceByHumanId (CreateDeviceRequest, CreateDeviceResponse)

  dns.proto:41

  Create device by "human_id". This method may return the following errors: - RateLimitedError: If the request was made too frequently and the client must wait before retrying. - DeviceQuotaExceededError: If the client has exceeded its quota for creating devices. - BadRequestError: If the request is invalid: DNS server does not exist, creation of auto-devices is disabled or human_id validation failed. - AuthenticationFailedError: If the authentication failed.

  message CreateDeviceRequest

  dns.proto:306

  • string dns_id = 1

  • string human_id = 2

  • DeviceType device_type = 3

  message CreateDeviceResponse

  dns.proto:312

  • optional DeviceSettings device = 1

• rpc getDNSProfiles (DNSProfilesRequest, stream DNSProfile)

  dns.proto:22

  Gets DNS profiles. Field "sync_time" in DNSProfilesRequest - pass to return the latest updates after this time moment. The trailers headers will include a "sync_time", given in milliseconds, that should be used for subsequent incremental DNS profile synchronization requests. This method may return the following errors: - RateLimitedError: If too many "full sync" concurrent requests are made. - AuthenticationFailedError: If the authentication failed.

  message DNSProfilesRequest

  dns.proto:110

  • optional google.protobuf.Timestamp sync_time = 1

  message DNSProfile

  dns.proto:114

  • string dns_id = 1

  • bool filtering_enabled = 2

  • bool query_log_enabled = 3

  • bool deleted = 4

  • optional SafeBrowsingSettings safe_browsing = 5

  • optional ParentalSettings parental = 6

  • optional RuleListsSettings rule_lists = 7

  • repeated DeviceSettings devices = 8

    Field devices contains the COMPLETE list of all devices in the profile. Field device_changes contains only the list of changes that have happened to the profile's devices since sync_time. devices and device_changes MUST NOT be set at the same time, but they MAY both be empty. device_changes MUST NOT contain multiple changes for the same device.

  • repeated string custom_rules = 9

  • optional google.protobuf.Duration filtered_response_ttl = 10

  • bool block_private_relay = 11

  • bool block_firefox_canary = 12

  • oneof blocking_mode

    • BlockingModeCustomIP blocking_mode_custom_ip = 13

    • BlockingModeNXDOMAIN blocking_mode_nxdomain = 14

    • BlockingModeNullIP blocking_mode_null_ip = 15

    • BlockingModeREFUSED blocking_mode_refused = 16

  • bool ip_log_enabled = 17

  • optional AccessSettings access = 18

  • bool auto_devices_enabled = 19

  • optional RateLimitSettings rate_limit = 20

  • bool block_chrome_prefetch = 21

  • optional CustomDomainSettings custom_domain = 22

  • string account_id = 23

  • repeated DeviceSettingsChange device_changes = 24

  • bool standard_access_settings_enabled = 25

• rpc saveDevicesBillingStat (stream DeviceBillingStat, google.protobuf.Empty)

  dns.proto:30

  Stores devices activity. This method may return the following errors: - AuthenticationFailedError: If the authentication failed.

  message DeviceBillingStat

  dns.proto:262

  • optional google.protobuf.Timestamp last_activity_time = 1

  • string device_id = 2

  • string client_country = 3

  • uint32 proto = 4

    Protocol type. Possible values see here: https://bit.adguard.com/projects/DNS/repos/dns-server/browse#ql-properties

  • uint32 asn = 5

  • uint32 queries = 6

• rpc getGlobalAccessSettings (GlobalAccessSettingsRequest, GlobalAccessSettingsResponse)

  dns.proto:53

  Gets global access settings.

  message GlobalAccessSettingsRequest

  dns.proto:104

  (message has no fields)

  message GlobalAccessSettingsResponse

  dns.proto:106

  • optional AccessSettings standard = 1

• rpc getRateLimitSettings (RateLimitSettingsRequest, RateLimitSettingsResponse)

  dns.proto:48

  Gets rate limit settings.

  message RateLimitSettingsRequest

  dns.proto:98

  (message has no fields)

  message RateLimitSettingsResponse

  dns.proto:100

  • repeated CidrRange allowed_subnets = 1

• rpc get (RemoteKVGetRequest, RemoteKVGetResponse)

  dns.proto:63

  * Get the value for the specified key. This method may return the following errors: - AuthenticationFailedError: If the authentication failed.

  message RemoteKVGetRequest

  dns.proto:343

  • string key = 1

  message RemoteKVGetResponse

  dns.proto:347

  • oneof value

    • bytes data = 1

    • google.protobuf.Empty empty = 2

• rpc set (RemoteKVSetRequest, RemoteKVSetResponse)

  dns.proto:72

  * Set the value for the specified key. This method may return the following errors: - AuthenticationFailedError: If the authentication failed. - BadRequestError: If the request is invalid: value size exceeds the 512kb.

  message RemoteKVSetRequest

  dns.proto:354

  • string key = 1

  • bytes data = 2

  • optional google.protobuf.Duration ttl = 3

  message RemoteKVSetResponse

  dns.proto:360

  (message has no fields)

• rpc getSessionTickets (SessionTicketRequest, SessionTicketResponse)

  dns.proto:95

  Gets session ticket for the current date This method may return the following errors: - AuthenticationFailedError: If the authentication failed.

  message SessionTicketRequest

  dns.proto:371

  (message has no fields)

  message SessionTicketResponse

  dns.proto:373

  • repeated SessionTicket tickets = 1

Used in: DNSProfile, GlobalAccessSettingsResponse

• repeated CidrRange allowlist_cidr = 1

• repeated CidrRange blocklist_cidr = 2

• repeated uint32 allowlist_asn = 3

• repeated uint32 blocklist_asn = 4

• repeated string blocklist_domain_rules = 5

• bool enabled = 6

• string message = 1

Used in: DeviceSettings

• bool doh_auth_only = 1

• oneof doh_password_hash

  • bytes password_hash_bcrypt = 2

• string message = 1

Used in: DNSProfile

• bytes ipv4 = 1

• bytes ipv6 = 2

Used in: DNSProfile

(message has no fields)

Used in: DNSProfile

(message has no fields)

Used in: DNSProfile

(message has no fields)

Used in: AccessSettings, RateLimitSettings, RateLimitSettingsResponse

• bytes address = 1

• uint32 prefix = 2

* Custom domain. <p>Field <code>domains</code> must not be empty</p>

Used in: CustomDomainSettings

• repeated string domains = 1

• oneof state

  • CustomDomain.Pending pending = 2

  • CustomDomain.Current current = 3

Used in: CustomDomain

• string cert_name = 1

• optional google.protobuf.Timestamp not_before = 2

• optional google.protobuf.Timestamp not_after = 3

• bool enabled = 4

Used in: CustomDomain

• string well_known_path = 1

• optional google.protobuf.Timestamp expire = 2

Used in: DNSProfile

• repeated CustomDomain domains = 1

• bool enabled = 2

Used in: WeeklyRange

• optional google.protobuf.Duration start = 1

• optional google.protobuf.Duration end = 2

• string message = 1

Used in: CreateDeviceResponse, DNSProfile, DeviceSettingsChange.Upserted

• string id = 1

• string name = 2

• bool filtering_enabled = 3

• bytes linked_ip = 4

• repeated bytes dedicated_ips = 5

• optional AuthenticationSettings authentication = 6

• string human_id_lower = 7

  Value in lower case. Will be empty for "ordinary" devices and non-empty for "automatically" created devices.

Used in: DNSProfile

• oneof change

  • DeviceSettingsChange.Deleted deleted = 1

  • DeviceSettingsChange.Upserted upserted = 2

Used in: DeviceSettingsChange

• string device_id = 1

Used in: DeviceSettingsChange

• optional DeviceSettings device = 1

Used in: CreateDeviceRequest

• INVALID = 0

• WINDOWS = 1

• ANDROID = 2

• MAC = 3

• IOS = 4

• LINUX = 5

• ROUTER = 6

• SMART_TV = 7

• GAME_CONSOLE = 8

• OTHER = 9

• string message = 1

Used in: DNSProfile

• bool enabled = 1

• bool block_adult = 2

• bool general_safe_search = 3

• bool youtube_safe_search = 4

• repeated string blocked_services = 5

• optional ScheduleSettings schedule = 6

Used in: DNSProfile

• bool enabled = 1

• uint32 rps = 2

• repeated CidrRange client_cidr = 3

• string message = 1

• optional google.protobuf.Duration retry_delay = 2

Used in: DNSProfile

• bool enabled = 1

• repeated string ids = 2

Used in: DNSProfile

• bool enabled = 1

• bool block_dangerous_domains = 2

• bool block_nrd = 3

Used in: ParentalSettings

• string tmz = 1

• optional WeeklyRange weekly_range = 2

Used in: SessionTicketResponse

• string name = 1

• bytes data = 2

Used in: ScheduleSettings

• optional DayRange mon = 1

• optional DayRange tue = 2

• optional DayRange wed = 3

• optional DayRange thu = 4

• optional DayRange fri = 5

• optional DayRange sat = 6

• optional DayRange sun = 7