Developer Documentation
Child pages
  • WHM API 1 Functions - mail_sni_status
Skip to end of metadata
Go to start of metadata

 

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

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

Note:

In cPanel & WHM version 60 and later, 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.

Examples 

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/mail_sni_status?api.version=1&domain=example.com
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/mail_sni_status?api.version=1&domain=example.com
 Command Line
whmapi1 mail_sni_status domain=example.com


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
    "data": {
        "enabled": 1
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": "1",
        "command": "mail_sni_status"
    }
}
 Output (XML)
<result>
    <data>
        <enabled>1</enabled>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>mail_sni_status</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The account's domain.

A valid cPanel account on the server.example.com

 

Returns

ReturnTypeDescriptionPossible valuesExample

enabled

BooleanWhether SNI for mail is enabled.
  • 1 — Enabled.
  • 0 — Disabled.
1

Function information

API Version:

WHM API 1

Available in:

WHM 11.48+

Methods:

GET, POST

Required Parameters:

domain

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions