Return domains that allow SSL certificate purchase

This function lists every domain for which you may purchase an SSL certificate. The possible domains for the Secure Sockets Layer (SSL) certificate include applicable service subdomains.

SecurityBasicAuth
Request
query Parameters
hide_temporary_domains
integer
Default: 0

Whether to hide temporary domains from the returned values.

  • 1 — Return an error if the requested domain is a temporary domain.
  • 0 — Return all domains, including the temporary domains. Note:

If you set this parameter's value to 1 and the requested domain is temporary, the function will return an error similar to the following example: Domain [example.com] is a temporary domain and hide_temporary_domains is enabled.

Enum: 1 0
Example: hide_temporary_domains=1
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/WebVhosts/list_ssl_capable_domains
Request samples
uapi --output=jsonpretty \
  --user=username \
  WebVhosts \
  list_ssl_capable_domains
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "list_ssl_capable_domains",
  • "module": "WebVhosts",
  • "result": {
    • "data": [
      • {
        • "domain": "example.com",
        • "is_proxy": 1,
        • "vhost_name": "hostname.example.com"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}