Return SSL-encrypted domain for service access

This function retrieves the most appropriate SSL-encrypted domain to use to access a service.

Authorizations:
query Parameters
service
required
string

The service's name.

Example: service=whostmgr

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  get_best_ssldomain_for_service \
  service='whostmgr'

Response samples

Content type
application/json
{
  • "data": {
    • "cert_match_method": "none",
    • "cert_valid_not_after": 1457452989,
    • "is_currently_valid": 0,
    • "is_self_signed": 1,
    • "is_wild_card": 0,
    • "ssldomain": "hostname.example.com",
    • "ssldomain_matches_cert": 0
    },
  • "metadata": {
    • "command": "get_best_ssldomain_for_service",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}