Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
SSL
cPanel Account SSL Management

Request best SSL domain for service

This function retrieves the most secure domain for a service.

get/SSL/get_cn_name

Query parameters

string domain required

A valid domain.

OR
string email required

A valid email address.

OR
string username required

A valid cPanel username.

A domain name, cPanel username, or email address.

service'cpanel' | 'imap' | 'pop3' | 'smtp' required
Example:cpanel

The service's name.

  • cpanel
  • imap
  • pop3
  • smtp
add_mail_subdomain1 | 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.

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": "get_cn_name",
  "module": "SSL",
  "result": {
    "data": {
      "cert_match_method": "hostname",
      "cert_valid_not_after": 1394288638,
      "is_self_signed": 1,
      "ssldomain": "hostname.example.com",
      "ssldomain_matches_cert": 1
    },
    "status": 1
  }
}