Integrate with your Marketplace via APIs
This section helps Partners or Distributors to integrate in their Marketplace.
Create an MSP trial account
To get started, you need to use the createCompany method from Companies API to create a partner company account with a monthly license trial.
To create a partner company account with a monthly license trial, set the following parameters specifically:
Parameter | Type | Description | Notes |
|---|---|---|---|
| Number | The company type. | Set value to |
| Object | An object containing the license details. | Set |
Return value: This method returns a string with the ID of the newly created partner company. You can use this string for other workflows. For more information about this method, refer to createCompany.
Create a customer monthly subscription trial account
To create a customer (end-user) account under an MSP with a monthly subscription trial set the following parameters specifically:
Parameter | Type | Description | Notes |
|---|---|---|---|
| Number | The company type. | Set value to |
| Object | An object containing the license details. | Set |
Return value: This method returns a string with the ID of the newly created customer company. For more information about this method, refer to createCompany.
Set a monthly subscription
Use the setMonthlySubscription method and set the following parameters in any sequence:
Parameter | Type | Optional | Description |
|---|---|---|---|
| String | No | The ID of the company that will inherit license seats from the parent company. |
| Number | Yes | The number of seats ensured for the target company from the parent's company total amount of seats. The default value is 0, meaning that no seats will be reserved. If no value is passed, the parameter preserves its previous value. |
| Boolean | Yes | True for allowing the company to use the Security for Exchange service, False otherwise. Default value is False. |
| Boolean | Yes | True for allowing the company to use the Full Disk Encryption service, False otherwise. Default value is False. |
| Boolean | Yes | True for allowing the company to use the Security for Virtualized Environments service, False otherwise. Default value is False. |
| Boolean | Yes | True for allowing the company to use the HyperDetect service, False otherwise. Default value is False. |
| Boolean | Yes | True for allowing the company to use the Sandbox Analyzer service, False otherwise. Default value is False. |
| Boolean | Yes | True for allowing the company to use the Patch Management service, False otherwise. Default value is False. |
| Boolean | Yes | True for allowing the company to use the Endpoint Detection and Response (EDR) service, False otherwise. Default value is False. EDR requires Sandbox Analyzer and HyperDetect to be enabled. Any change of this parameter's value will automatically set the parameters manageSandboxAnalyzer and manageHyperDetect with the same value. Omitting passing a value will not affect the values set for these two parameters.. |
Return value: This method returns a string with the ID of the newly created partner company. You can use this string for other workflows. For more information about this method, refer to createCompany.
The MSP receives a welcoming email from with a link to the and its provisioned credentials. We recommend MSPs to change the password upon the first login.
Note
To invoice based on usage without setting a hard limit count for MSP license consumption, do not specify the reservedSlots parameter.
Check the usage at the end of the month
If you do not have any add-ons enabled, you can pull the monthly usage directly from through the getMonthlyUsage method, by specifying the targetMonth (last month) and companyID parameters of your MSP account.
To check the usage at the end of the month, set the following parameters in any sequence:
Parameter | Type | Description |
|---|---|---|
| String | The ID of the company. The default value is the ID of the company linked to the user who generated the API key. |
| String | The month for which the usage is returned. It should have the following format: |
For usage calculators and reports about add-ons enabled for your MSP, refer to this Calculate the endpoint usage with the Monthly License Usage report
Obtain a company’s ID
Use the findCompaniesByName method from Companies API to obtain a company ID, its usage or the company details. For more information about this method, refer to findCompaniesByName.
Check for enabled add-ons in an MSP account
Use the getLicenseInfo method from Licensing API to retrieve license information for a company. For more information about this method, refer to getLicenseInfo.
Enable or disable add-ons in an MSP account
Use the setMonthlySubscription method from Companies API to enable or disable additional Cloud Security for MSP add-ons, by setting the parameters to True or False.
To enable or disable additional protection layers, set the following parameters in any sequence:
Parameter | Type | Description | Notes |
|---|---|---|---|
| Boolean |
| Security for add-on. |
| Boolean |
| Full Disk Encryption add-on. |
| Boolean |
| Security for Virtualized Environments add-on. |
| Boolean |
| Hyper Detect, as part of Advanced Threat Security add-on. |
| Boolean |
| , as part of Advanced Threat Security add-on. |
| Boolean |
| Patch Management add-on. |
| Boolean |
requires and Hyper Detect to be enabled. Any change of this parameter's value will automatically set the parameters | add-on. |
Return value: This method does not return any value. For more information about this method, refer to setMonthlySubscription
To add a second add-on on top of any existing service, you need to include all previous parameters associated with add-ons that are already enabled.
Setting these parameters results in enabling or disabling the ability to deploy and license add-ons.
If you enable an add-on, the MSP can deploy the associated module on existing and newly added endpoints. An add-on used at least once during the month is counted for usage.
If you disable an add-on, the associated module is deactivated and its usage is not generated for the upcoming month. As a result, the MSP is unable to manage any module associated with a disabled add-on.
Suspend MSP account in case of contract breach
You are always in control and able to act when a contractual agreement breach occurs.
The suspendCompany method from the Companies API allows you to suspend active companies with unpaid bills or other contract infringements.
Under these circumstances, you can suspend a company’s access to and deactivate associated endpoints. You can choose to apply this recursively to all managed companies by the MSP, to prevent the usage from accumulating in a given month. For more information about this method, refer to suspendCompany
To activate suspended companies, refer to activateCompany.