Page History

Include Page

	LIB:_WHMAPI1Menu
	LIB:_WHMAPI1Menu

Description

Excerpt
This function lists a domain's MX records.

Multiexcerpt include

SpaceWithExcerpt	com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptName	APIDisabledDNSRole
PageWithExcerpt	LIB:_ServerRoleDisabledAPI

Panel

bgColor	#F2F2F2
borderStyle	none

Examples

Panel

bgColor	#FFFFFF
borderStyle	none

Expand

title	JSON API

Code Block

language	xml

https://hostname.example.com:2087/cpsess##########/json-api/listmxs?api.version=1&domain=example.com

Expand

title	XML API

Code Block

language	xml

https://hostname.example.com:2087/cpsess##########/xml-api/listmxs?api.version=1&domain=example.com

Expand

title	Command Line

Code Block

language	bash

whmapi1 listmxs domain=example.com

Include Page

	LIB:_WHMAPI1CLINote
	LIB:_WHMAPI1CLINote

Expand

title	Output (JSON)

Code Block

language	text
linenumbers	true

{
   "data":{
      "record":[
         {
            "Line":"21",
            "ttl":"14400",
            "class":"IN",
            "exchange":"mx1.example.com",
            "preference":"0",
            "type":"MX",
            "name":"example.com."
         },
         {
            "Line":"28",
            "ttl":"14400",
            "class":"IN",
            "exchange":"mx2.example.com",
            "preference":"20",
            "type":"MX",
            "name":"example.com.example.com."
         }
      ]
   },
   "metadata":{
      "result":1,
      "reason":"Records obtained.",
      "version":1,
      "command":"listmxs"
   }
}

Expand

title	Output (XML)

Code Block

language	xml
linenumbers	true

<result>
    <data>
        <record>
            <Line>21</Line>
            <ttl>14400</ttl>
            <class>IN</class>
            <exchange>mx1.example.com</exchange>
            <preference>0</preference>
            <type>MX</type>
            <name>example.com.</name>
        </record>
        <record>
            <Line>28</Line>
            <ttl>14400</ttl>
            <class>IN</class>
            <exchange>mx2.example.com</exchange>
            <preference>20</preference>
            <type>MX</type>
            <name>example.com</name>
        </record>
    </data>
    <metadata>
        <result>1</result>
        <reason>Records obtained.</reason>
        <version>1</version>
        <command>listmxs</command>
    </metadata>
</result>

Include Page

	LIB:_WHMAPIShellNote
	LIB:_WHMAPIShellNote

Parameters

Parameter Type Description Possible values Example

domain

string

Required

The zone record's domain.

A valid domain name on the server.

example.com

Returns

Return Type Description Possible values Example

record

array of hashes

An array of zone record data hashes.

This array of hashes includes the name, Line, class, ttl, type, exchange, and preference returns.

name

string

The record's name.