Skip to content

Commit d9cb63f

Browse files
[1.1.1.1] Add warning about lack of RFC for DoH JSON format (#19756)
* [1.1.1.1] Add warning about lack of RFC for DoH JSON format * Minor style guide adjustments --------- Co-authored-by: Rebecca Tamachiro <[email protected]>
1 parent b5a125a commit d9cb63f

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

src/content/docs/1.1.1.1/encryption/dns-over-https/make-api-requests/dns-json.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ title: Using JSON
44
slug: 1.1.1.1/encryption/dns-over-https/make-api-requests/dns-json
55
---
66

7+
:::caution
8+
The DNS over HTTPS JSON format does not have a formal RFC, which means behavior might be different between providers. Additionally, there might be small changes in behavior in the future.
9+
10+
For critical use cases, it is recommended to use the [DNS over HTTPS wireformat](/1.1.1.1/encryption/dns-over-https/make-api-requests/dns-wireformat/), which is defined in [RFC 1035](https://www.rfc-editor.org/rfc/rfc1035.html).
11+
:::
12+
713
Cloudflare's DNS over HTTPS endpoint also supports JSON format for querying DNS data. For lack of an agreed upon JSON schema for DNS over HTTPS in the Internet Engineering Task Force (IETF), Cloudflare has chosen to follow the same schema as Google's DNS over HTTPS resolver.
814

915
JSON formatted queries are sent using a `GET` request. When making requests using `GET`, the DNS query is encoded into the URL. The client should include an HTTP `Accept` request header field with a MIME type of `application/dns-json` to indicate that the client is able to accept a JSON response from the DNS over HTTPS resolver.

src/content/docs/1.1.1.1/encryption/dns-over-https/make-api-requests/dns-wireformat.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ head:
77
slug: 1.1.1.1/encryption/dns-over-https/make-api-requests/dns-wireformat
88
---
99

10-
Cloudflare respects DNS wireformat as defined in [RFC 1035](https://datatracker.ietf.org/doc/html/rfc1035).
10+
Cloudflare respects DNS wireformat as defined in [RFC 1035](https://www.rfc-editor.org/rfc/rfc1035.html).
1111

1212
To send queries using DNS wireformat, set the header `accept: application/dns-message`, or `content-type: application/dns-message` if using `POST` to signalize the media type of the query.
1313

0 commit comments

Comments
 (0)