v58

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-073053701.0 MB

Domains: Portfolio

Claim free domain

Claim a free domain available on your account and register it.

Unlike purchasing a domain, this consumes a free domain you already have, so no payment method is required.

A successful response means the domain is registered. If registration fails, login to hPanel and check domain registration status.

If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account.

Some TLDs require additional_details to be provided and these will be validated before claiming.

Requests which cannot be fulfilled are rejected with an error code in the response body, for example 2037 when no free domain is available.

Use this endpoint to register a domain using a free domain from your account.

post/api/domains/v1/portfolio/claim

Request body

domainstring required

Domain name

additional_detailsobject

Additional registration data, possible values depends on TLD

Example request

{
  "domain": "my-new-domain.tld",
  "domain_contacts": {
    "owner_id": 741288,
    "admin_id": 546123,
    "billing_id": 741288,
    "tech_id": 741288
  }
}

Response

Success response

domainstring nullable

Domain name

Domain status

created_atstring date-time nullable

Example response

{
  "domain": "mydomain.tld",
  "status": "active",
  "created_at": "2026-08-05T10:14:22Z"
}