API Guide

Overview #

You can use the WebPros Cloud API to provision and manage customer accounts, products, and credentials on the WebPros Cloud platform using API calls.

For the list of available API calls, read our WebPros Cloud API documentation.

How to create API Tokens #

To integrate your platform with WebPros Cloud, you must generate an API token.

To obtain an API token, perform the following steps:

1. Log in to the WebPros Cloud Client Area interface.
2. Click Services and select My Services from the dropdown menu. The My Products & Services interface will appear.
3. The table will display a list of your products. Click on the name of the product for which you wish to create an API token. The Product Details interface will appear.
4. In the Actions menu, click Manage API Tokens. The Manage API Tokens interface will appear.
5. Click Create New Token. A Create API Token box will appear.
6. Select the token expiration date. Then, click Create New Token.
   Important:

   The system will only display the secret part of your token once. You should store the secret part in a secure location. You cannot retrieve it later.

Calling the API #

The API uses the JSON format for all request body and response data.

Credentials, in the form of an API token ID and secret, must be presented in the HTTP headers of every API call.

The following example uses the entitlement call to retrieve a list of entitlements:

 1$ curl -X GET \
 2       -H'X-WPC-API-TokenID: 3a5c555c-04b7-13f0-a8b6-023c26f9bc95' \
 3       -H'X-WPC-API-TokenSecret: <insert your token secret here>' \
 4       https://api.webpros.cloud/v1/entitlement
 5{
 6    "data": [
 7        {
 8            "id": "01234567-89ab-cdef-0123-456789abcdef",
 9            "userId": "01234567-89ab-cdef-0123-456789abcdef",
10            "productId": "cpanel-server-small",
11            "suspended": false,
12            "creationDate": "2025-04-15T12:57:34Z",
13            "modificationDate": null,
14            "data": {
15                "maxSites": 1000,
16                "maxDiskKb": 1000,
17                "usedSites": 0,
18                "usedDiskKb": 0
19            }
20        }
21    ],
22    ...more objects...,
23    "next": "01234567-89ab-cdef-0123-456789abcdef"
24}