Return Market providers' products metadata

This function lists all available cPanel Market providers' products and the attributes of each product that can be managed by an administrator.

The return list includes different attribute data depending the product_group for each product.

Product Group Attributes Returned Description
ssl_certificate SSLMarketProviderMetaData Contains additional attributes only applicable to SSL Certificates
* MarketProviderMetaData Any products not in a product_group listed above will include only these attributes.

Note:

The function does not return the product_group name.

To get the product_group name for a product_id, run WHM API 1's get_market_providers_products function.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  get_market_providers_product_metadata

Response samples

Content type
application/json
{
  • "data": {
    • "product_metadata": [
      • {
        • "attributes": {
          • "display_name": {
            • "read_only": 1
            },
          • "enabled": {
            • "read_only": 1
            },
          • "icon": {
            • "read_only": 1
            },
          • "icon_mime_type": {
            • "read_only": 1
            },
          • "minimum_server_price": {
            • "read_only": 1
            },
          • "price": {
            • "read_only": 1
            },
          • "price_unit": {
            • "read_only": 1
            },
          • "product_description": {
            • "read_only": 1
            },
          • "product_group": {
            • "read_only": 1
            },
          • "product_id": {
            • "read_only": 1
            },
          • "recommended": {
            • "read_only": 1
            }
          },
        • "product_id": "123",
        • "provider_display_name": "cPanel Store",
        • "provider_name": "cPStore"
        }
      ]
    },
  • "metadata": {
    • "command": "get_market_providers_product_metadata",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}