Knowledgebase

Get Sending Domains

Method: GET
Endpoint: /api/getSendingDomains


Parameters

Parameter Type Required Description
id int No Sending domain id which you want to get
limit_start int (default: 0) No Starting row of result. Default: 0
limit_count int (default: 25) No Number of records to get. Default: 25


Response Parameters

Parameter Type Description
status JSON Success or Error
result JSON Result of the operation
response JSON Output of the operation


Example Request (CURL)

<?php

// Authentication
$api_token	=	'API_KEY'; // Mumara API Key (can be found in Settings -> API Key)
$domain		=	'http://www.anydomain.com'; // Your Mumara Domain Name

// API Endpoint
$endpoint	=	'/api/getSendingDomains';

//parameters
$data = array (
    'limit_start'	=> '1',
    'limit_count'	=> '2'
);

$params = '';
foreach($data as $key=>$value)
    $params .= $key.'='.$value.'&';
$params = trim($params, '&');

// Defining cURL Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,$domain.$endpoint.'?'.$params);
curl_setopt($ch, CURLOPT_HTTPHEADER,
    array('Content-Type: application/json', 'Authorization: Bearer ' . $api_token));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Executing cURL
$output = curl_exec ($ch);

// Printing Output
echo "<pre>";
echo json_encode(json_decode($output),JSON_PRETTY_PRINT );

// Closing cURL
curl_close ($ch);

?>

 

Example Response (JSON)

 {
    "status": "success",
    "result": [
        {
            "id": 60,
            "dns_id": null,
            "zone": null,
            "domain": "test.com",
            "type": "cname",
            "user_id": 2,
            "pmta_id": 0,
            "spf": null,
            "dkim_public": "v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA51Hh+YtArmKtb9/xYlIlCk229AlyuyqzDrOZg+2taQ37/6TU1ULTXgW5+SOwMDsE4oalw14KU5XHu8Bh2Vls7VGWqpLymMjXznvt4J6nUDMLHNJnY4LSYJpbOFuvfqdKIzheKu0ypWO7b84dGIWYknn7eK+F+vXoZxkjGQ3p3byNnyZHxefM3OR/peIAdfmADPohl/Y9VGmfSHbe5d069n1T4Nc1RIT0uWyhxU7zYUJjJch+AuR3D4KoMnjCD4Z6KVC+OFTpQ5jSCy/zpJkomY7/kEWd3t5fHOe3U80LuTG0G3kcsGhsVygLcud25bBIbOP0aoN4O8h2uoJ+C2JXYQIDAQAB",
            "dkim_private": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDnUeH5i0CuYq1v\n3/FiUiUKTbb0CXK7KrMOs5mD7a1pDfv/pNTVQtNeBbn5I7AwOwTihqXDXgpTlce7\nwGHZWWztUZaqkvKYyNfOe+3gnqdQMwsc0mdjgtJgmls4W69+p0ojOF4q7TKlY7tv\nzh0YhZiSeft4r4X69ehnGSMZDendvI2fJkfF58zc5H+l4gB1+YAM+iGX9j1UaZ9I\ndt7l3Tr2fVPg1zVEhPS5bKHFTvNhQmMlyH4C5HcPgqgyeMIPhnopUL44VOlDmNIL\nL/OkmSiZjv+QRZ3e3l8c57dTzQu5MbQbeRywaGxXKAty53blsEhs4/Rqg3g7yHa6\ngn4LYldhAgMBAAECggEANbBYnZ3HfnIixSOaF/Lu6+xLuWpz+aMYeiIPUIKazBZV\n1ekBCRqAioMTvhKdcyRPpvAPiz/Jb8sE17v4OgU6df6I1MBUlEeRZzh2ZrsMJF4k\nhyUCoCMeBxPsdjE5k1DqsTAFEzuIlMCIIZQaRrXDSsQLLOC4XR40ObGo5sjG7hLD\nUDquPPw2WIcAtcVPS4JdipDCpLw09NzLxx/2mL3+Xs2H55NWqzk8b0yHnFxdUUch\n3K4XtJFa8JHwQqlVYPmpjqrKZM63iraDsHt64QHPOYHUTNFLYJVf67lqp9wtrUzd\n8iMsIys/AgMcYT57RStmDujve4VhbXimQ7/JYBmz3QKBgQD9x5pPdUU76ytJiLKo\nnIVixD7ONxqOKaE7mrsPehW1pJSvHvsxsBye+sJlzTQpfZ/D4A8EPfMj+aTdRy4Q\ndJK+foDn0mcTMNjQGwWEb5w+2gj8DtwpEQqJ2R5nZCzneWkPoTo+1RPHz2UGXjdY\nW/l4dGfMmUEWpKU2B1yKIkAbqwKBgQDpV/ncjR074+Ink6aDx1EOitFaQOJAy5jM\n5pKZMy/uhvmlkDUBqyEqvD34B1G+Zn9G5s3zgYEPdsq+eMEO1n7kCWPjqrpY/Gpv\n/TTDC6Rd78Yjko03cbRi4w8iGn6BoV8QcQEDFCz4ueEa64qHh2Wr5h+m0z9emN6x\nKuAfkcStIwKBgQCeg1lwPhiTl41/LcIiLTnnehqcpbCRkZEi8L/cp+39eiJgy+Is\npAsMhiZ8fdMSA2SSbVYT2ToQg3Mlv7sXDilGkS+lHTfCteUG/4nPsgMPAxNPlVyQ\nzhMeDR6/h8PAhYZI+/SsoFztli5M7vZ022YUhej709Hi+c4z1B9KLKCMZwKBgDDI\nQKc4JSVxJcWKW6RvFeYJZW0N5X8QUVh816cJiXq/Yw+Wz04S/bMWeYoR1agNe4xS\nEjpXF6ko94fMbOfyNcLsp6Jf/ec+le3lrJMeKvWse+rR543wynpl57MEgPAO0XX5\nefGv1RsGmSXsmiBtUPcX/AP/Y98d7Ghzgzl2WvyrAoGAGTxf6/UbnD6PzRQd4Lr9\noGR4X8iH52+Gcqy5WdGzMhn0zK+IWx2Ef6CsEvyp1ZF9bn7kPEW5wGHF4Wv4tOL/\n3TdRbqZEStkFhqonQQnHuPwGK8+VXA6yGQAUTp2tm4svLolf8FOlu41jXJFRUjQT\nBEA5XiBNCI64xfNebCPk1FQ=\n-----END PRIVATE KEY-----\n",
            "dkim_public_key": null,
            "created_at": "2021-07-16 12:57:08",
            "updated_at": "2021-08-12 10:04:54",
            "tracking_domain": "click1",
            "tracking_status": "Active",
            "bounce_status": null,
            "domain_status": 4,
            "is_confirm_dns": 0,
            "is_confirm": 0,
            "is_confirm_redirect": 0,
            "is_confirm_mx": 0,
            "is_confirm_spf": 0,
            "email_selector": "key1",
            "bounce_selector": "bounce",
            "is_verified": null,
            "is_enable_dkim": 1,
            "is_confirm_clicked": 0,
            "is_ssl_enabled": null
        }
     ]
 }
Status value of the success response will be "Success"


Example Error Response (JSON)

{
    "status": "error",
    "result": "Error: Record doesn't exist."
}


Possible Errors

  • Error: Record doesn't exist.
  • Access Denied
GET
/api/getSendingDomains
Try it out