Request best SSL domain for service

This function retrieves the most secure domain for a service.

Authorizations:
query Parameters
required
string or string or string

A domain name, cPanel username, or email address.

Example: domain=example.com
service
required
string

The service's name.

  • cpanel
  • imap
  • pop3
  • smtp
Enum: "cpanel" "imap" "pop3" "smtp"
Example: service=cpanel
add_mail_subdomain
integer
Default: 0

Whether to append mail to the domain value to find the best match.

For example, if you specify the domain example.com and call this parameter, the function only searches the mail.example.com service domains.

  • 1 — Append mail to the domain value during the search.
  • 0 — Match on the specified domain value only.
Enum: 1 0
Example: add_mail_subdomain=0

Responses

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

Request samples

uapi --user=username SSL get_cn_name domain='example.com' service='cpanel'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_cn_name",
  • "module": "SSL",
  • "result": {
    • "data": {
      • "cert_match_method": "hostname",
      • "cert_valid_not_after": 1394288638,
      • "is_currently_valid": 0,
      • "is_self_signed": 1,
      • "is_wild_card": 0,
      • "ssldomain": "hostname.example.com",
      • "ssldomain_matches_cert": 1
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}