Skip to content

Commit a0ba4e9

Browse files
authored
Deprecation: Remove getWhoisPrivacy and renewWhoisPrivacy endpoints (#919)
These endpoints were deprecated on 2023-05-01. The WHOIS privacy state can now be retrieved through getDomain, and WHOIS privacy no longer requires renewal as it stays enabled unless explicitly disabled.
1 parent 16fff7e commit a0ba4e9

File tree

6 files changed

+12
-207
lines changed

6 files changed

+12
-207
lines changed

content/v2/openapi.yml

Lines changed: 8 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1450,27 +1450,17 @@ paths:
14501450
'/{account}/registrar/domains/{domain}/whois_privacy':
14511451
get:
14521452
deprecated: true
1453-
description: Gets the whois privacy status for an existing domain.
1453+
description: 'This endpoint has been deprecated and removed. Use getDomain instead.'
14541454
parameters:
14551455
- $ref: '#/components/parameters/Account'
14561456
- $ref: '#/components/parameters/Domain'
14571457
operationId: getWhoisPrivacy
14581458
tags:
14591459
- registrar privacy
14601460
responses:
1461-
'200':
1462-
description: Successfully retrieved whois privacy details.
1463-
content:
1464-
application/json:
1465-
schema:
1466-
type: object
1467-
required: [data]
1468-
properties:
1469-
data:
1470-
$ref: '#/components/schemas/WhoisPrivacy'
1471-
'404':
1472-
$ref: '#/components/responses/404'
1473-
summary: WHOIS privacy status
1461+
'410':
1462+
description: This endpoint has been removed.
1463+
summary: WHOIS privacy status (deprecated)
14741464
put:
14751465
description: |-
14761466
Enables the WHOIS privacy for the domain.
@@ -1531,32 +1521,17 @@ paths:
15311521
'/{account}/registrar/domains/{domain}/whois_privacy/renewals':
15321522
post:
15331523
deprecated: true
1534-
description: |-
1535-
Renews the WHOIS privacy for the domain.
1536-
1537-
Note that if the WHOIS privacy was never purchased for the domain or if there is another renewal order in progress, renewing WHOIS privacy will return an error.
1524+
description: 'This endpoint has been deprecated and removed. WHOIS privacy no longer requires renewal.'
15381525
parameters:
15391526
- $ref: '#/components/parameters/Account'
15401527
- $ref: '#/components/parameters/Domain'
15411528
operationId: renewWhoisPrivacy
15421529
tags:
15431530
- registrar privacy
15441531
responses:
1545-
'201':
1546-
description: Successfully renew whois privacy.
1547-
content:
1548-
application/json:
1549-
schema:
1550-
type: object
1551-
required: [data]
1552-
properties:
1553-
data:
1554-
$ref: '#/components/schemas/WhoisPrivacyRenewal'
1555-
'400':
1556-
$ref: '#/components/responses/400'
1557-
'404':
1558-
$ref: '#/components/responses/404'
1559-
summary: Renew WHOIS privacy
1532+
'410':
1533+
description: This endpoint has been removed.
1534+
summary: Renew WHOIS privacy (deprecated)
15601535
'/{account}/secondary_dns/primaries':
15611536
get:
15621537
summary: List primary servers
@@ -6178,43 +6153,6 @@ components:
61786153
enabled: true
61796154
created_at: '2016-02-13T14:34:50Z'
61806155
updated_at: '2016-02-13T14:34:52Z'
6181-
WhoisPrivacyRenewal:
6182-
type: object
6183-
required:
6184-
- id
6185-
- domain_id
6186-
- whois_privacy_id
6187-
- state
6188-
- enabled
6189-
- expires_on
6190-
- created_at
6191-
- updated_at
6192-
properties:
6193-
id:
6194-
type: integer
6195-
domain_id:
6196-
type: integer
6197-
whois_privacy_id:
6198-
type: integer
6199-
state:
6200-
type: string
6201-
enabled:
6202-
type: boolean
6203-
expires_on:
6204-
$ref: '#/components/schemas/Date'
6205-
created_at:
6206-
$ref: '#/components/schemas/DateTimeCreatedAt'
6207-
updated_at:
6208-
$ref: '#/components/schemas/DateTimeUpdatedAt'
6209-
example:
6210-
id: 1
6211-
domain_id: 100
6212-
whois_privacy_id: 999
6213-
state: new
6214-
enabled: true
6215-
expires_on: '2020-01-10'
6216-
created_at: '2019-01-10T12:12:48Z'
6217-
updated_at: '2019-01-10T12:12:48Z'
62186156
Zone:
62196157
type: object
62206158
description: Represents a DNS zone.

content/v2/registrar/whois-privacy.md

Lines changed: 4 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,8 @@ Enable and disable WHOIS privacy on registered domains.
1616

1717
## Retrieve the domain WHOIS privacy {#getWhoisPrivacy}
1818

19-
GET /:account/registrar/domains/:domain/whois_privacy
20-
21-
Get the WHOIS privacy details for a domain.
22-
23-
> [!WARNING] Deprecated since 01 May 2023
24-
> This endpoint has been deprecated. You can retrieve a domain WHOIS privacy state through [retrieve domain](/v2/domains/#getDomain).
25-
26-
### Parameters
27-
28-
Name | Type | Description
29-
-----|------|------------
30-
`:account` | `integer` | The account id
31-
`:domain` | `string`, `integer` | The domain name or id
32-
33-
### Example
34-
35-
Get WHOIS privacy for the domain `example.com` in the account `1010`:
36-
37-
curl -H 'Authorization: Bearer <token>' \
38-
-H 'Accept: application/json' \
39-
https://api.dnsimple.com/v2/1010/registrar/domains/example.com/whois_privacy
40-
41-
### Response
42-
43-
Responds with HTTP 200 on success
44-
45-
```json
46-
<%= pretty_print_fixture("/api/getWhoisPrivacy/success.http") %>
47-
```
19+
> [!WARNING]
20+
> This endpoint has been deprecated and removed. Use [retrieve domain](/v2/domains/#getDomain) instead.
4821
4922
## Enable WHOIS privacy {#enableWhoisPrivacy}
5023

@@ -124,39 +97,5 @@ Responds with [HTTP 401](/v2/#unauthorized) in case of case of authentication is
12497

12598
## Renew WHOIS privacy {#renewWhoisPrivacy}
12699

127-
```
128-
POST /:account/registrar/domains/:domain/whois_privacy/renewals
129-
```
130-
131-
> [!WARNING] Deprecated since 01 May 2023
132-
> This endpoint has been deprecated. You no longer need to renew the WHOIS privacy service. It will stay enabled unless you disable it.
133-
134-
### Parameters
135-
136-
Name | Type | Description
137-
-----|------|------------
138-
`:account` | `integer` | The account id
139-
`:domain` | `string`, `integer` | The domain name or id
140-
141-
### Example
142-
143-
Renew WHOIS privacy for the domain `example.com` in the account `1010`:
144-
145-
curl -H 'Authorization: Bearer <token>' \
146-
-H 'Accept: application/json' \
147-
-X POST \
148-
https://api.dnsimple.com/v2/1010/registrar/domains/example.com/whois_privacy/renewals
149-
150-
### Response
151-
152-
Responds with HTTP 201 if WHOIS privacy is renewed.
153-
154-
```json
155-
<%= pretty_print_fixture("/api/renewWhoisPrivacy/success.http") %>
156-
```
157-
158-
### Errors
159-
160-
Responds with [HTTP 400](/v2/#bad-request) if WHOIS privacy cannot be renewed.
161-
162-
Responds with [HTTP 401](/v2/#unauthorized) in case of case of authentication issues.
100+
> [!WARNING]
101+
> This endpoint has been deprecated and removed. WHOIS privacy no longer requires renewal.

fixtures/v2/api/getWhoisPrivacy/success.http

Lines changed: 0 additions & 16 deletions
This file was deleted.

fixtures/v2/api/renewWhoisPrivacy/success.http

Lines changed: 0 additions & 20 deletions
This file was deleted.

fixtures/v2/api/renewWhoisPrivacy/whois-privacy-duplicated-order.http

Lines changed: 0 additions & 18 deletions
This file was deleted.

fixtures/v2/api/renewWhoisPrivacy/whois-privacy-not-found.http

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)