WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_adjusted_market_providers_products
- A server running WHM.
https://whm-server.tld:2087/json-api/get_adjusted_market_providers_products
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_adjusted_market_providers_productsResponse
application/json
{ "data": { "products": [ … ] }, "metadata": { "command": "get_adjusted_market_providers_products", "reason": "OK", "result": 1, "version": 1 } }
Request
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.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_market_providers_product_metadata
- A server running WHM.
https://whm-server.tld:2087/json-api/get_market_providers_product_metadata
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_market_providers_product_metadataResponse
application/json
{ "data": { "product_metadata": [ … ] }, "metadata": { "command": "get_market_providers_product_metadata", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_market_providers_products
- A server running WHM.
https://whm-server.tld:2087/json-api/get_market_providers_products
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_market_providers_productsResponse
application/json
{ "data": { "products": [ … ] }, "metadata": { "command": "get_market_providers_products", "reason": "OK", "result": 1, "version": 1 } }