Skip to content

Commit 69524f0

Browse files
author
Janik Rabe
authored
[API deprecation] DNS Records API: Changes to Filter Parameters (#18103)
1 parent 80b2c1b commit 69524f0

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

src/content/changelogs/api-deprecations.yaml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,44 @@ entries:
117117
118118
Replacement: [Rate limiting rules](/waf/rate-limiting-rules/) (new version)
119119
120+
- publish_date: "2025-02-21"
121+
title: "DNS Records API: Changes to Filter Parameters"
122+
description: |-
123+
Deprecation date: February 21, 2025
124+
125+
The following URL parameters for filtering DNS records are deprecated:
126+
127+
- `name=contains:value`
128+
Instead, use the supported `name.contains=value` syntax.
129+
- `name=starts_with:value`
130+
Instead, use the supported `name.startswith=value` syntax.
131+
- `name=ends_with:value`
132+
Instead, use the supported `name.endswith=value` syntax.
133+
- `name=one,two,three` (searching for one of multiple possible names, separated by commas)
134+
Instead, make multiple requests, one for each possible `name`.
135+
Alternatively, if only querying the `name` field, the `?match=any&name=one&name=two&name=three` syntax can be used instead.
136+
This syntax has an extended deprecation date of May 23, 2025.
137+
- `content=contains:value`
138+
Instead, use the supported `content.contains=value` syntax.
139+
- `content=starts_with:value`
140+
Instead, use the supported `content.startswith=value` syntax.
141+
- `content=ends_with:value`
142+
Instead, use the supported `content.endswith=value` syntax.
143+
- `content=one,two,three` (searching for one of multiple possible contents, separated by commas)
144+
Instead, make multiple requests, one for each possible `content`.
145+
Alternatively, if only querying the `content` field, the `?match=any&content=one&content=two&content=three` syntax can be used instead.
146+
This syntax has an extended deprecation date of May 23, 2025.
147+
- `type=contains:value`
148+
Searching for substrings of a type name will no longer be supported.
149+
Instead, please search for an exact type name, such as `type=CNAME`.
150+
If the input value is a free-text search from a human user, consider using the `search` parameter instead.
151+
152+
None of the parameters being deprecated were ever officially supported per our API documentation.
153+
154+
Affected APIs:
155+
156+
- `GET /zones/:zone_id/dns_records`
157+
120158
- publish_date: "2024-11-30"
121159
title: "Zone information in individual DNS records"
122160
description: |-

0 commit comments

Comments
 (0)