UAPI Functions - Market::get_providers_list - Knowledgebase

Description

This function lists the names of enabled cPanel Market providers.

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List providers in the cPanel Market.

$list_providers = $cpanel->uapi(

'Market', 'get_providers_list'

);

LiveAPI Perl Module

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'

);

cPanel Template Toolkit

[% execute('Market', 'get_providers_list' ) %]

Command Line

uapi --user=username Market get_providers_list

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

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

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
data	array of hashes	An array that lists enabled providers in the cPanel Market.	This array includes the nameand display_name returns.
name	string	The cPanel Market provider's name. This function returns this value in the datahash.	A valid string.	cPStore
display_name	string	The cPanel Market provider's display name. This function returns this value in the datahash.	A valid string.	cPanel Store

Knowledgebase

Categories

Categories