Command: List User Domains

This api command returns list of domains owned by a specific user.

Command:

API Command Name: list_userdomains

Required Parameters:

user_name

UserName of the account

  • If username is 'root' then all domains, subomains and extra domains hosted on server will be returened
  • If username is a reseller account then all domains, sub domains and extra domains hosted under that reseller account will be returned
  • If username is a regular user then all domains, sub domains and extra domains hosted by that account will be returned.

Optional Parameters:

Account information will be returnred in a comma separated list format, Additionally these encoddings can also apply to output:

gzcompress Data will be compressed by gzcompress function with default level.
base64_encode Data will be packed by base64_encode function.
chunk_split Data will be chunked by chunk_split function.

Above encodings can be passed to API in form of encoding_n parameters where n is a number between 1 and 5. For instance if you send encoding_1=gzcompress&encoding_2=base64_encode then these functions will be applied to list:

  1. gzcompress
  2. base64_encode

And if you send encoding_1=base64_encode then you will receive data provided by these functions:

  1. base64_encode

A your end, you may decode the information in reverse order.

Note on output:

In any form of encoding data will be wrapped by -----DATA-START----- and -----DATA-END----- tags. So to grap the correct data your script can do a preg_match like this:

if(preg_match('/-----DATA-START-----(.*)-----DATA-END-----/smiU',$returned_data,$matches))
{
	$real_data = $matches[1];
	// routine to decode the data, i.e:
	// $data_array = base64_decode(explode(',',$real_data));
}

Sample request to send to Say5 api:

$request  = 'command=list_userdomains&user_name=testuser&encoding_1=base64_encode';
 
 
Copyright 2007-2019 Say5 Inc.