Child pages
  • WHM API 1 Functions - get_market_providers_product_metadata
Skip to end of metadata
Go to start of metadata

Description

This function lists the metadata of all available cPanel Market providers' products.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_market_providers_product_metadata?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_market_providers_product_metadata?api.version=1
 Command Line
whmapi1 get_market_providers_product_metadata


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "data":{
      "product_metadata":[
         {
            "provider_display_name":"cPanel Store",
            "provider_name":"cPStore",
            "product_id":"143",
            "attributes":{   
               "description":{                  
                 "read_only":1
               },
               "display_name":{                  
                 "read_only":1
               },
               "enabled":{                  
                 "read_only":1
               },                  
                 "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_group":{                  
                 "read_only":1
               },  
               "product_id":{                  
                 "read_only":1
               },  
               "recommended":{                  
                 "read_only":1
               },
               "x_identity_verification":{
                 "read_only":1
               },
               "x_max_http_redirects":{                  
                 "read_only":1
               },
               "x_price_per_domain":{                  
                 "read_only":1
               },  
               "x_price_per_domain_minimum":{                  
                 "read_only":1
               },  
               "x_price_per_wildcard_domain":{                  
                 "read_only":1
               },
               "x_price_per_wildcard_domain_maximum":{                  
                 "read_only":1
               },
               "x_price_per_wildcard_domain_minimum":{                  
                 "read_only":1
               },
               "x_ssl_per_domain_pricing":{                  
                 "read_only":1
               },
               "x_supports_dns_dcv":{                  
                 "read_only":1
               },
               "x_wildcard_parent_domain_free":{                  
                 "read_only":1
               }
            }
         },
            "provider_display_name":"cPanel Store",
            "provider_name":"cPStore",
            "product_id":"176",
         {  
            "attributes":{   
               "description":{                  
                 "read_only":1
               },
               "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_group":{                  
                 "read_only":1
               },  
               "product_id":{                  
                 "read_only":1
               },  
               "recommended":{                  
                 "read_only":1
               },  
               "x_max_http_redirects":{                  
                 "read_only":1
               },
               "x_price_per_domain":{                  
                 "read_only":1
               },  
               "x_price_per_domain_minimum":{                  
                 "read_only":1
               },  
               "x_price_per_wildcard_domain":{                  
                 "read_only":1
               },
               "x_price_per_wildcard_domain_maximum":{                  
                 "read_only":1
               },
               "x_price_per_wildcard_domain_minimum":{                  
                 "read_only":1
               },
               "x_ssl_per_domain_pricing":{                  
                 "read_only":1
               },  
               "x_wildcard_parent_domain_free":{                  
                 "read_only":1
               }
            }
         }
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"get_market_providers_product_metadata"
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <command>get_market_providers_product_metadata</command>
        <reason>OK</reason>
        <result>1</result>
    </metadata>
    <data>
        <product_metadata>
            <attributes>
                <price_unit>
                    <read_only>1</read_only>
                </price_unit>
                <recommended>
                    <read_only>1</read_only>
                </recommended>
                <product_id>
                    <read_only>1</read_only>
                </product_id>
                <price>
                    <read_only>1</read_only>
                </price>
                <display_name>
                    <read_only>1</read_only>
                </display_name>
                <x_price_per_domain_minimum>
                    <read_only>1</read_only>
                </x_price_per_domain_minimum>
                <x_max_http_redirects>
                    <read_only>1</read_only>
                </x_max_http_redirects>
				<x_identity_verification>
                    <read_only>1</read_only>
                </x_identity_verification>
                <x_price_per_wildcard_domain>
                    <read_only>1</read_only>
                </x_price_per_wildcard_domain>
                <x_price_per_wildcard_domain_minimum>
                    <read_only>1</read_only>
                </x_price_per_wildcard_domain_minimum>
                <x_price_per_wildcard_domain_maximum>
                    <read_only>1</read_only>
                </x_price_per_wildcard_domain_maximum>
                <x_wildcard_parent_domain_free>
                    <read_only>1</read_only>
                </x_wildcard_parent_domain_free>
                <product_group>
                    <read_only>1</read_only>
                </product_group>
                <icon_mime_type>
                    <read_only>1</read_only>
                </icon_mime_type>
                <x_ssl_per_domain_pricing>
                    <read_only>1</read_only>
                </x_ssl_per_domain_pricing>
                <enabled>
                    <read_only>1</read_only>
                </enabled>
                <minimum_server_price>
                    <read_only>1</read_only>
                </minimum_server_price>
                <description>
                    <read_only>1</read_only>
                </description>
                <x_price_per_domain>
                    <read_only>1</read_only>
                </x_price_per_domain>
				<x_identity_verification>
                    <read_only>1</read_only>
				</x_identity_verification>
				<x_supports_dns_dcv>
                    <read_only>1</read_only>
				</x_supports_dns_dcv>
                <icon>
                    <read_only>1</read_only>
                </icon>
            </attributes>
            <provider_display_name>cPanel Store</provider_display_name>
            <product_id>143</product_id>
            <provider_name>cPStore</provider_name>
        </product_metadata>
        <product_metadata>
            <provider_display_name>cPanel Store</provider_display_name>
            <product_id>176</product_id>
            <provider_name>cPStore</provider_name>
            <attributes>
                <x_ssl_per_domain_pricing>
                    <read_only>1</read_only>
                </x_ssl_per_domain_pricing>
                <icon_mime_type>
                    <read_only>1</read_only>
                </icon_mime_type>
                <product_group>
                    <read_only>1</read_only>
                </product_group>
                <x_price_per_domain_minimum>
                    <read_only>1</read_only>
                </x_price_per_domain_minimum>
                <x_max_http_redirects>
                    <read_only>1</read_only>
                </x_max_http_redirects>
                <x_price_per_wildcard_domain>
                    <read_only>1</read_only>
                </x_price_per_wildcard_domain>
                <x_price_per_wildcard_domain_minimum>
                    <read_only>1</read_only>
                </x_price_per_wildcard_domain_minimum>
                <x_price_per_wildcard_domain_maximum>
                    <read_only>1</read_only>
                </x_price_per_wildcard_domain_maximum>
                <x_wildcard_parent_domain_free>
                    <read_only>1</read_only>
                </x_wildcard_parent_domain_free>
                <price>
                    <read_only>1</read_only>
                </price>
                <product_id>
                    <read_only>1</read_only>
                </product_id>
                <display_name>
                    <read_only>1</read_only>
                </display_name>
                <recommended>
                    <read_only>0</read_only>
                </recommended>
                <price_unit>
                    <read_only>1</read_only>
                </price_unit>
                <icon>
                    <read_only>1</read_only>
                </icon>
                <x_price_per_domain>
                    <read_only>0</read_only>
                </x_price_per_domain>
                <description>
                    <read_only>1</read_only>
                </description>
                <minimum_server_price>
                    <read_only>1</read_only>
                </minimum_server_price>
                <enabled>
                    <read_only>0</read_only>
                </enabled>
            </attributes>
        </product_metadata>
    </data>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

Note:

The returns in the attributes hash, and each return within each hash that the attributes hash contains, depend on the parameters that the cPanel Market provider module and product use.

ReturnTypeDescriptionPossible valuesExample
product_metadataarray of hashes

An array of hashes that contains metadata information about all market provider's products.

Each hash includes the provider_display_name, provider names, and product_id returns and the attributes hash. 

provider_display_name

string

The cPanel Market provider's display name.

The function returns this value in the product_metadata hash.

A valid string.cPanel Store

provider_name

string

The cPanel Market provider's name.

The function returns this value in the product_metadata hash.

A valid string.cPStore

product_id

string

The product's ID.

Note:

The product's ID is this return's name.

The function returns this value in the product_metadata hash.

A valid string.123

attributes

hash

A hash that contains information about the product's attributes.

The function returns this hash in the product_metadata hash.

This hash includes the price, enabled, icon_mime_type, product_group, product_description, product_id, price_unit, icon, display_name, minimum_server_price, and recommended hashes. 

price

hash

A hash that contains metadata information about the product's price.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the price hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

enabled

hash

A hash that contains metadata information about whether the product is enabled in the Market.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the enabled hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

icon_mime_type

hash

A hash that contains metadata information about the icon's mime type.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the icon_mime_type hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

product_group

hash

A hash that contains metadata information about the product's group label.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the product_group hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

product_description

hash

A hash that contains metadata information about the product's description.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the product_description hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

product_id

hash

A hash that contains metadata information about the product's ID.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the product_id hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

price_unit

hash

A hash that contains metadata information about the product's price per unit.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the price_unit hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

display_name

hash

A hash that contains metadata information about the product's display name.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the display_name hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

icon

hash

A hash that contains metadata information about the product's icon file.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the icon hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

recommended

hash

A hash that contains metadata information about whether the product is recommended.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the recommended hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

minimum_server_price

hash

A hash that contains metadata information about the minimum server price for the certificate.

The function returns this hash in the attributes hash.

This hash includes the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the minimum_server_price hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1

Note:

Additional returns that are specific to each product may appear in the attributes hash. The names of the additional returns begin with the x_ prefix.

product_group=ssl_certificate

ReturnTypeDescriptionPossible valuesExample
x_ssl_per_domain_pricinghash

A hash that contains metadata information about the product's pricing per domain.

This hash contains the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the x_ssl_per_domain_pricing hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_price_per_domain_minimumhashA hash that contains information about the minimum allowable price per domain for the certificate.This hash contains the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value in the x_price_per_domain_minimum hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_price_per_domainhashA hash that contains metadata information about the product's price per domain.This hash contains the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value as part of the x_price_per_domain hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_price_per_domain_maximumhashA hash that contains information about the maximum allowable price per domain for the certificate.This hash contains the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value as part of the x_price_per_domain_maximum hash.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_warn_afterhashA hash that contains information about a length of time after which the cPanel interface will warn the user that there may be a problem with the order.This hash contains the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value as part of the x_warn_after hash.

 

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_price_per_wildcard_domain hash

A hash that contains information about the price per wildcard certificate.

Note:

We introduced this return in cPanel & WHM version 60.

This hash contains the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value as part of the x_price_per_wildcard_domain hash.

Note:

We introduced this return in cPanel & WHM version 60.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_price_per_wildcard_domain_minimumhash

A hash that contains information about the maximum allowable price per wildcard certificate.

Note:

We introduced this return in cPanel & WHM version 60.

 This hash contains the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value as part of the x_price_per_wildcard_domain_minimum hash.

Note:

We introduced this return in cPanel & WHM version 60.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_price_per_wildcard_domain_maximumhash

A hash that contains information about the maximum allowable price per wildcard certificate.

Note:

We introduced this return in cPanel & WHM version 60.

 This hash contains the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value as part of the x_price_per_wildcard_domain_maximum hash.

Note:

We introduced this return in cPanel & WHM version 60.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_wildcard_parent_domain_free
hash

A has that contains information about whether the provider includes the price of the parent domain in the price of a wildcard certificate.

Note:

We introduced this return in cPanel & WHM version 60.

This hash contains the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value as part of the x_wildcard_parent_domain_free hash.

Note:

We introduced this return in cPanel & WHM version 60.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_max_http_redirects hash

A hash that contains information about maximum number of HTTP redirections that the provider allows during a Domain Control Validation (DCV) check of the domain or domains in the certificate.

Note:

We introduced this return in cPanel & WHM version 60.

This hash contains the read_only return. 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value as part of the x_max_http_redirects hash.

Note:

We introduced this return in cPanel & WHM version 60.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_identity_verificationarray of hashes

An array of hashes that define a schema for identity verification information for OV and EV certificates.

Note:

We introduced this return in cPanel & WHM version 62. 


This hash contains the read_only return.

 

read_only

Boolean

Whether the attribute is read-only.

The function returns this value as part of the x_identity_verification hash.

Note:

We introduced this return in cPanel & WHM version 62. 

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1
x_supports_dns_dcvhashA hash that contains information about whether supports DNS-based DCV.This hash contains the read_only return.

read_only

Boolean

Whether the attribute is read-only.

The function returns this value as part of the x_supports_dns_dcv hash.

Note:

We introduced this return in cPanel & WHM version 74.

  • 1 — The attribute is read-only.
  • 0 — System administrators can edit the attribute.
1