Return status of domain's SNI mail services

This function retrieves the status of the domain's SNI mail services.

Warning:

Mail SNI is not compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.

Note:

Mail SNI is always enabled.

  • Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.
  • Functions that disable Mail SNI fail and make no changes.
SecurityBasicAuth
Request
query Parameters
domain
required
string <domain>

The account's domain.

Example: domain=example.com
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/SSL/mail_sni_status
Request samples
uapi --output=jsonpretty \
  --user=username \
  SSL \
  mail_sni_status \
  domain='example.com'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "mail_sni_status",
  • "module": "SSL",
  • "result": {
    • "data": {
      • "enabled": 1
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}