WhoisGuard
List WhoisGuard entries
Section titled “List WhoisGuard entries”Namecheap: whoisguard.getList
GET /whoisguard?listType=ALL| Param | Values | Default |
|---|---|---|
listType | ALL, ALLOTED, FREE, EXPIRED | ALL |
page | number | 1 |
pageSize | number | 20 |
Response 200
{ "data": [ { "id": "38495", "domainName": "example.com", "created": "05/13/2024", "expires": "05/13/2025", "status": "enabled" } ], "meta": { "totalItems": 1, "currentPage": 1, "pageSize": 20 }}Enable
Section titled “Enable”Namecheap: whoisguard.enable
POST /whoisguard/:id/enable{ "forwardedToEmail": "forward@example.com" }Disable
Section titled “Disable”Namecheap: whoisguard.disable
POST /whoisguard/:id/disableNamecheap: whoisguard.renew
POST /whoisguard/:id/renew{ "years": 1 }Allot to a domain
Section titled “Allot to a domain”Assign a WhoisGuard subscription to a domain.
Namecheap: whoisguard.allot
POST /whoisguard/:id/allot{ "domainName": "example.com", "forwardedToEmail": "forward@example.com"}Unallot
Section titled “Unallot”Detach WhoisGuard from a domain (doesn’t delete it).
POST /whoisguard/:id/unallotChange forwarding email
Section titled “Change forwarding email”POST /whoisguard/:id/email{ "forwardedToEmail": "new@example.com" }Response 200
{ "data": { "whoisguardId": "38495", "isSuccess": true, "newEmail": "new@example.com", "oldEmail": "old@example.com" }}