Description

This function lists the names of enabled cPanel Market providers.

Examples


https://hostname.example.com:2083/cpsess##########/execute/Market/get_providers_list

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List providers in the cPanel Market.
$list_providers = $cpanel->uapi(
    'Market', 'get_providers_list'
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List providers in the cPanel Market.
my $list_providers = $cpliveapi->uapi(
    'Market', 'get_providers_list'
);

 

<!-- List providers in the cPanel Market -->
[% execute('Market', 'get_providers_list' ) %]

 

uapi --user=username Market get_providers_list

{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  
      "transformed":1
   },
   "data": [
         {  
            "name":"cPStore",
            "display_name":"cPanel Store"
         },
         {  
            "name":"Farnsworth"
            "display_name":"Farnsworth Industries"
         }
    ]
}

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

data

array of hashes

An array that lists enabled providers in the cPanel Market.

This array includes the name and display_name returns. 

name

string

The cPanel Market provider's name.

This function returns this value in the data hash.

A valid string.cPStore

display_name

string

The cPanel Market provider's display name.

This function returns this value in the data hash.

A valid string.cPanel Store