HelipodDocs

WHOIS

Look up WHOIS data for any domain, and turn WHOIS protection on or off for your domains.

WHOIS lookup

GET/domains/whois
Public WHOIS data for a domain.

Works for any registered domain, not only yours.

Prop

Type

curl "https://api.helipod.io/api/domains/whois?domain=example.com" \
  -H "Authorization: Bearer hel_your_key"
Response
{
  "success": true,
  "data": {
    "domain": "example.com",
    "...": "..."
  }
}

data.domain is always present. The other fields are the WHOIS data as returned by the registry, and their names and format depend on the extension, so parse them defensively. A domain the registry does not know returns 404 NOT_FOUND or 422 REGISTRAR_REJECTED; a registry outage returns 502 REGISTRAR_ERROR.

WHOIS protection

WHOIS protection hides your owner details (name, address, phone, email) from public WHOIS. {id} is the domain id from GET /domains/mine. A domain with status pending_profile returns 409 DOMAIN_PENDING_PROFILE.

You can also buy protection when you register a domain (whoisProtection: true). A transfer does not include it: enable it here once the transfer is complete. While it is enabled, its fee is added to each renewal, including automatic ones.

The price is the same everywhere and is shown as whois_protection in the price list: currently Rp 20,000 per year.

Get the status

GET/domains/{id}/whois-protection
Current WHOIS protection state at the registry.
curl https://api.helipod.io/api/domains/42/whois-protection \
  -H "Authorization: Bearer hel_your_key"
Response
{ "success": true, "data": { "enabled": true } }

data.enabled tells whether protection is on. The registry may include more fields. The whoisProtection field in GET /domains/{id} holds the same answer as last set through Helipod.

Enable

POST/domains/{id}/whois-protectioncharges your wallet
Turn on WHOIS protection.

No body. The fee is the whois_protection price (currently Rp 20,000). It is charged before protection is enabled, and refunded if the registry refuses.

curl -X POST https://api.helipod.io/api/domains/42/whois-protection \
  -H "Authorization: Bearer hel_your_key"
Response
{ "success": true, "message": "WHOIS protection enabled", "charged": 20000 }

charged is the amount taken from your wallet. 402 INSUFFICIENT_BALANCE when the balance is too low (nothing charged).

When protection is already on, the call answers 409 WHOIS_PROTECTION_ACTIVE and charges nothing, so a repeated call never makes you pay twice.

Disable

DELETE/domains/{id}/whois-protection
Turn off WHOIS protection.

Free. The fee already paid is not refunded.

curl -X DELETE https://api.helipod.io/api/domains/42/whois-protection \
  -H "Authorization: Bearer hel_your_key"
Response
{ "success": true, "message": "WHOIS protection disabled" }

Errors

StatuscodeWhen
402INSUFFICIENT_BALANCEWallet balance too low to enable protection.
404DOMAIN_NOT_FOUNDUnknown or non-numeric domain id, or the domain is not registered at the registry yet.
409DOMAIN_PENDING_PROFILEThe domain waits for owner details.
409WHOIS_PROTECTION_ACTIVEProtection is already on. Nothing was charged.
422VALIDATION_ERRORdomain missing on lookup.
422REGISTRAR_REJECTEDThe registry refused the request. Any charge was refunded.
502REGISTRAR_ERRORThe registry could not be reached. Any charge was refunded.

On this page