Child pages
  • UAPI Functions - Market::get_providers_list
Skip to end of metadata
Go to start of metadata

 

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


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 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'
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 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'
);


Note:

For more information, read our Guide to the LiveAPI System.

 

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


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Market get_providers_list


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

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