WebVhosts
Virtual Host Information
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.
get/WebVhosts/list_ssl_capable_domains
Query parameters
hide_temporary_domains1 | 0
Example:1
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.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "list_ssl_capable_domains",
"module": "WebVhosts",
"result": {
"data": [
{
"domain": "example.com",
"is_proxy": 1,
"vhost_name": "hostname.example.com"
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}