v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

DomainRecommendations

List the TLDs supported by the domain store

This function returns the list of top-level domains (TLDs) that the configured domain store supports for registration.

The system caches the results for up to two minutes. Use the use_cache=0 option to bypass the cache and force a live request.

Note:

This function requires the domain_recommendation feature.

get/DomainRecommendations/supported_tlds

Query parameters

use_cache1 | 0

Example:1

Whether to use the local response cache.

1 — Use the cache (default). The system caches the results for up to two minutes.
0 — Bypass the cache and make a live request to the store.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "supported_tlds",
  "module": "DomainRecommendations",
  "result": {
    "data": {
      "tlds": [
        "com",
        "net",
        "org",
        "io"
      ]
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}