Retrieve full license details including edition, counts, and add-ons
Returns the complete license state -- edition, expiry, resource counts, and add-on details. For a lighter endpoint-only view, use Get License Endpoints.
Endpoint
Copy full URL
Request URL
https://{serverurl}/dcapi/license Copied!
Scope
DesktopCentralCloud.Admin.READCopied!
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Request Parameters
- Request Headers
AcceptstringMandatoryapplication/licenseDetails.v1+jsonapplication/licenseDetails.v1+jsonCopied!
Sample Request
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomains/dcapi/license \
--header 'Accept: application/licenseDetails.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Response Parameters
- HTTP code 200
Response Body - application/json
JSON Object
Hide Sub-Attributes
isLicensePromotedboolean
True when a promotional trial is active.
trialDaysLeftlong
Days remaining in the promotional trial. Present only when isLicensePromoted is true.
payNowstring
CTA text for purchasing the promoted license. Present only when isLicensePromoted is true.
downgradeNowstring
CTA text for reverting to the previous edition. Present only when isLicensePromoted is true.
Actionstring
Downgrade action identifier. Present only when isLicensePromoted is true.
licenseEditionstring
License edition display name.
productNamestring
Product display name.
buildNumberstring
Build-number string.
licensedTostring
Company or username the license is registered to.
licenseExpiryDatestring
Formatted expiry date. Absent for free/trial licenses.
evaluationDaysLeftstring
Days remaining for trial licenses. Absent for registered/free licenses.
subscriptionFrequencystring
Subscription renewal frequency. Values: 'YEARLY' or 'MONTHLY'.
addonDetailsJSON Object
Add-on enablement status and detailed list.
Show Sub-Attributes
isMultiLangEnabledboolean
True if the multi-language pack add-on is enabled.
isBasicTrainingEnabledboolean
True if any training add-on is purchased (Standard Online, Onsite, or Advanced Online).
isPremiumSupportEnabledboolean
True if premium support tier is active.
addonDetailsListJSON Array
Detailed list of add-on statuses for UI rendering.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
keystring
Add-on identifier name (e.g. 'Multi-language Pack', 'Training', 'Support Type').
labelstring
Display label for the add-on status (e.g. 'Enabled', 'Disabled', 'Classic', 'Premium').
statusboolean
True if the add-on is enabled. Null for support type when it is Classic (not premium).
purchaseActionTextstring
CTA text for purchasing/upgrading the add-on (e.g. 'Upgrade'). Null when the add-on is already enabled.
keystring
Add-on identifier name (e.g. 'Multi-language Pack', 'Training', 'Support Type').
labelstring
Display label for the add-on status (e.g. 'Enabled', 'Disabled', 'Classic', 'Premium').
statusboolean
True if the add-on is enabled. Null for support type when it is Classic (not premium).
purchaseActionTextstring
CTA text for purchasing/upgrading the add-on (e.g. 'Upgrade'). Null when the add-on is already enabled.
JSON Object
Show Sub-Attributes
keystring
Add-on identifier name (e.g. 'Multi-language Pack', 'Training', 'Support Type').
labelstring
Display label for the add-on status (e.g. 'Enabled', 'Disabled', 'Classic', 'Premium').
statusboolean
True if the add-on is enabled. Null for support type when it is Classic (not premium).
purchaseActionTextstring
CTA text for purchasing/upgrading the add-on (e.g. 'Upgrade'). Null when the add-on is already enabled.
keystring
Add-on identifier name (e.g. 'Multi-language Pack', 'Training', 'Support Type').
labelstring
Display label for the add-on status (e.g. 'Enabled', 'Disabled', 'Classic', 'Premium').
statusboolean
True if the add-on is enabled. Null for support type when it is Classic (not premium).
purchaseActionTextstring
CTA text for purchasing/upgrading the add-on (e.g. 'Upgrade'). Null when the add-on is already enabled.
isMultiLangEnabledboolean
True if the multi-language pack add-on is enabled.
isBasicTrainingEnabledboolean
True if any training add-on is purchased (Standard Online, Onsite, or Advanced Online).
isPremiumSupportEnabledboolean
True if premium support tier is active.
addonDetailsListJSON Array
Detailed list of add-on statuses for UI rendering.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
keystring
Add-on identifier name (e.g. 'Multi-language Pack', 'Training', 'Support Type').
labelstring
Display label for the add-on status (e.g. 'Enabled', 'Disabled', 'Classic', 'Premium').
statusboolean
True if the add-on is enabled. Null for support type when it is Classic (not premium).
purchaseActionTextstring
CTA text for purchasing/upgrading the add-on (e.g. 'Upgrade'). Null when the add-on is already enabled.
keystring
Add-on identifier name (e.g. 'Multi-language Pack', 'Training', 'Support Type').
labelstring
Display label for the add-on status (e.g. 'Enabled', 'Disabled', 'Classic', 'Premium').
statusboolean
True if the add-on is enabled. Null for support type when it is Classic (not premium).
purchaseActionTextstring
CTA text for purchasing/upgrading the add-on (e.g. 'Upgrade'). Null when the add-on is already enabled.
JSON Object
Show Sub-Attributes
keystring
Add-on identifier name (e.g. 'Multi-language Pack', 'Training', 'Support Type').
labelstring
Display label for the add-on status (e.g. 'Enabled', 'Disabled', 'Classic', 'Premium').
statusboolean
True if the add-on is enabled. Null for support type when it is Classic (not premium).
purchaseActionTextstring
CTA text for purchasing/upgrading the add-on (e.g. 'Upgrade'). Null when the add-on is already enabled.
keystring
Add-on identifier name (e.g. 'Multi-language Pack', 'Training', 'Support Type').
labelstring
Display label for the add-on status (e.g. 'Enabled', 'Disabled', 'Classic', 'Premium').
statusboolean
True if the add-on is enabled. Null for support type when it is Classic (not premium).
purchaseActionTextstring
CTA text for purchasing/upgrading the add-on (e.g. 'Upgrade'). Null when the add-on is already enabled.
usersJSON Object
Technician/user license counts.
Show Sub-Attributes
purchasedinteger
Purchased count for this resource.
managedinteger
Currently managed count for this resource.
excessesinteger
Count excluded from license enforcement (e.g. SDP-integrated resources). Present only when applicable.
viewUrlstring
Relative URL to the console page listing the managed resources.
purchasedinteger
Purchased count for this resource.
managedinteger
Currently managed count for this resource.
excessesinteger
Count excluded from license enforcement (e.g. SDP-integrated resources). Present only when applicable.
viewUrlstring
Relative URL to the console page listing the managed resources.
endpointsJSON Object
Endpoint license counts with split breakdown.
Show Sub-Attributes
purchasedinteger
Purchased endpoint count.
managedinteger
Total managed endpoint count (computers + MDM devices + OSD for unified plans).
splitDetailsJSON Object
Breakdown of managed endpoints by category. Present for UEM and Security edition plans.
Show Sub-Attributes
titlestring
Section heading for the split breakdown (e.g. 'Managed computer splitup:').
labelhelperstring
Explanatory note about what the OSD count represents.
managedComputersinteger
Agent-managed computer count (excludes OSD-only).
managedMDMDevicesinteger
Managed mobile device count. Present when MDM is integrated.
managedOSDComputersinteger
OS Deployed workstation count (OSD-only, no agent).
managedComputersDetailsJSON Array
Per-category breakdown: Computers vs OSD Computers.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
serverUsedForEndpointboolean
True when endpoint shortfall overflows into server licenses. Present only when endpoint managed count exceeds purchased.
titlestring
Section heading for the split breakdown (e.g. 'Managed computer splitup:').
labelhelperstring
Explanatory note about what the OSD count represents.
managedComputersinteger
Agent-managed computer count (excludes OSD-only).
managedMDMDevicesinteger
Managed mobile device count. Present when MDM is integrated.
managedOSDComputersinteger
OS Deployed workstation count (OSD-only, no agent).
managedComputersDetailsJSON Array
Per-category breakdown: Computers vs OSD Computers.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
serverUsedForEndpointboolean
True when endpoint shortfall overflows into server licenses. Present only when endpoint managed count exceeds purchased.
excessesinteger
Endpoints excluded from license enforcement (e.g. SDP-integrated). Present only when applicable.
viewUrlstring
Relative URL to the console page listing managed computers.
purchasedinteger
Purchased endpoint count.
managedinteger
Total managed endpoint count (computers + MDM devices + OSD for unified plans).
splitDetailsJSON Object
Breakdown of managed endpoints by category. Present for UEM and Security edition plans.
Show Sub-Attributes
titlestring
Section heading for the split breakdown (e.g. 'Managed computer splitup:').
labelhelperstring
Explanatory note about what the OSD count represents.
managedComputersinteger
Agent-managed computer count (excludes OSD-only).
managedMDMDevicesinteger
Managed mobile device count. Present when MDM is integrated.
managedOSDComputersinteger
OS Deployed workstation count (OSD-only, no agent).
managedComputersDetailsJSON Array
Per-category breakdown: Computers vs OSD Computers.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
serverUsedForEndpointboolean
True when endpoint shortfall overflows into server licenses. Present only when endpoint managed count exceeds purchased.
titlestring
Section heading for the split breakdown (e.g. 'Managed computer splitup:').
labelhelperstring
Explanatory note about what the OSD count represents.
managedComputersinteger
Agent-managed computer count (excludes OSD-only).
managedMDMDevicesinteger
Managed mobile device count. Present when MDM is integrated.
managedOSDComputersinteger
OS Deployed workstation count (OSD-only, no agent).
managedComputersDetailsJSON Array
Per-category breakdown: Computers vs OSD Computers.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
serverUsedForEndpointboolean
True when endpoint shortfall overflows into server licenses. Present only when endpoint managed count exceeds purchased.
excessesinteger
Endpoints excluded from license enforcement (e.g. SDP-integrated). Present only when applicable.
viewUrlstring
Relative URL to the console page listing managed computers.
computersJSON Object
Computer license counts. Present when endpoints key is not used.
Show Sub-Attributes
purchasedinteger
Purchased count for this resource.
managedinteger
Currently managed count for this resource.
excessesinteger
Count excluded from license enforcement (e.g. SDP-integrated resources). Present only when applicable.
viewUrlstring
Relative URL to the console page listing the managed resources.
purchasedinteger
Purchased count for this resource.
managedinteger
Currently managed count for this resource.
excessesinteger
Count excluded from license enforcement (e.g. SDP-integrated resources). Present only when applicable.
viewUrlstring
Relative URL to the console page listing the managed resources.
serversJSON Object
Server license counts with split breakdown.
Show Sub-Attributes
purchasedinteger
Purchased server count.
managedinteger
Total managed server count (SOM servers + OSD servers + endpoint shortfall overflow).
splitDetailsJSON Object
Breakdown of managed servers by category. Present for UEM and Security edition plans.
Show Sub-Attributes
titlestring
Section heading for the split breakdown (e.g. 'Managed servers splitup:').
labelhelperstring
Explanatory note about what the OSD count represents.
managedServersinteger
Total managed server count within the split.
managedOSDServersinteger
OS Deployed server count (OSD + agent-installed overlap).
managedServersDetailsJSON Array
Per-category breakdown: Agent Installed vs OS Deployed and agent installed.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
managedEndpointsinteger
Total endpoint count that overflowed into server licenses. Present only when endpoint shortfall exists.
managedEndpointsDetailsJSON Array
Endpoint overflow breakdown when endpoints exceed purchased count and spill into server licenses. Present only when shortfall exists.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
titlestring
Section heading for the split breakdown (e.g. 'Managed servers splitup:').
labelhelperstring
Explanatory note about what the OSD count represents.
managedServersinteger
Total managed server count within the split.
managedOSDServersinteger
OS Deployed server count (OSD + agent-installed overlap).
managedServersDetailsJSON Array
Per-category breakdown: Agent Installed vs OS Deployed and agent installed.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
managedEndpointsinteger
Total endpoint count that overflowed into server licenses. Present only when endpoint shortfall exists.
managedEndpointsDetailsJSON Array
Endpoint overflow breakdown when endpoints exceed purchased count and spill into server licenses. Present only when shortfall exists.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
excessesinteger
Servers excluded from license enforcement (e.g. SDP-integrated). Present only when applicable.
viewUrlstring
Relative URL to the console page listing managed servers.
purchasedinteger
Purchased server count.
managedinteger
Total managed server count (SOM servers + OSD servers + endpoint shortfall overflow).
splitDetailsJSON Object
Breakdown of managed servers by category. Present for UEM and Security edition plans.
Show Sub-Attributes
titlestring
Section heading for the split breakdown (e.g. 'Managed servers splitup:').
labelhelperstring
Explanatory note about what the OSD count represents.
managedServersinteger
Total managed server count within the split.
managedOSDServersinteger
OS Deployed server count (OSD + agent-installed overlap).
managedServersDetailsJSON Array
Per-category breakdown: Agent Installed vs OS Deployed and agent installed.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
managedEndpointsinteger
Total endpoint count that overflowed into server licenses. Present only when endpoint shortfall exists.
managedEndpointsDetailsJSON Array
Endpoint overflow breakdown when endpoints exceed purchased count and spill into server licenses. Present only when shortfall exists.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
titlestring
Section heading for the split breakdown (e.g. 'Managed servers splitup:').
labelhelperstring
Explanatory note about what the OSD count represents.
managedServersinteger
Total managed server count within the split.
managedOSDServersinteger
OS Deployed server count (OSD + agent-installed overlap).
managedServersDetailsJSON Array
Per-category breakdown: Agent Installed vs OS Deployed and agent installed.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
managedEndpointsinteger
Total endpoint count that overflowed into server licenses. Present only when endpoint shortfall exists.
managedEndpointsDetailsJSON Array
Endpoint overflow breakdown when endpoints exceed purchased count and spill into server licenses. Present only when shortfall exists.
Show Sub-Attributes
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
JSON Object
Show Sub-Attributes
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
countinteger
Count for this category.
labelstring
Display label (e.g. 'Agent Installed', 'OS Deployed and agent installed', 'Computers', 'OSD Computers').
excessesinteger
Servers excluded from license enforcement (e.g. SDP-integrated). Present only when applicable.
viewUrlstring
Relative URL to the console page listing managed servers.
storageSpaceJSON Object
Storage add-on usage.
Show Sub-Attributes
purchasedinteger
Purchased/allocated count for this resource.
managedstring
Currently used/managed count. String for storage (formatted GB), integer for other resources.
purchasedinteger
Purchased/allocated count for this resource.
managedstring
Currently used/managed count. String for storage (formatted GB), integer for other resources.
smsCreditsJSON Object
SMS credit counts.
Show Sub-Attributes
purchasedinteger
Purchased/allocated count for this resource.
managedstring
Currently used/managed count. String for storage (formatted GB), integer for other resources.
purchasedinteger
Purchased/allocated count for this resource.
managedstring
Currently used/managed count. String for storage (formatted GB), integer for other resources.
osdSystemsJSON Object
Add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
serversJSON Object
Server counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
osdLicenseEditionstring
License status (e.g. 'Enabled'). Present only for osdSystems add-on.
osdComputersJSON Object
Workstation counts. Present only for osdSystems add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
osdServersJSON Object
Server counts. Present only for osdSystems add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
serversJSON Object
Server counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
osdLicenseEditionstring
License status (e.g. 'Enabled'). Present only for osdSystems add-on.
osdComputersJSON Object
Workstation counts. Present only for osdSystems add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
osdServersJSON Object
Server counts. Present only for osdSystems add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
arwAddonJSON Object
Anti-Ransomware add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
ngavAddonJSON Object
Add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
blmAddonJSON Object
BitLocker Management add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
vmpAddonJSON Object
Add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
bspAddonJSON Object
Browser Security Plus add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
acpAddonJSON Object
Add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
dcpAddonJSON Object
Add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
dlpAddonJSON Object
Add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
edrAddonJSON Object
EDR add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
eaAddonJSON Object
Endpoint Analytics add-on details.
Show Sub-Attributes
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
statusboolean
True if this add-on is enabled/purchased.
isAddonTrialboolean
True if this add-on is in trial mode.
devicesJSON Object
Device/workstation counts for this add-on.
Show Sub-Attributes
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
purchasedinteger
Purchased/entitled count for this add-on resource type.
managedinteger
Currently managed/deployed count.
isShortfallboolean
True when managed exceeds purchased.
shortfallMessagestring
Localized shortfall message with excess count and store URL. Present only when isShortfall is true.
- HTTP code 500
Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codeinteger
Error code. 1001 indicates an unexpected failure while fetching license details.
error_descriptionstring
Human-readable error message describing the failure.
Sample Response: HTTP 200
Registered license with individual add-ons and shortfall
Copied!
{
"bspAddon": {
"devices": {
"purchased": 100,
"managed": 40,
"isShortfall": false
},
"isAddonTrial": false,
"status": true
},
"dlpAddon": {
"devices": {
"purchased": 100,
"managed": 45,
"isShortfall": false
},
"isAddonTrial": false,
"status": true
},
"endpoints": {
"purchased": 250,
"managed": 200,
"viewUrl": "/webclient#/uems/agent/som/computers?deviceType=2"
},
"ngavAddon": {
"devices": {
"purchased": 100,
"managed": 60,
"isShortfall": false
},
"isAddonTrial": false,
"status": true
},
"subscriptionFrequency": "YEARLY",
"blmAddon": {
"devices": {
"purchased": 100,
"managed": 80,
"isShortfall": false
},
"isAddonTrial": false,
"status": true
},
"buildNumber": "11.3.2423.0",
"productName": "Endpoint Central Cloud",
"licensedTo": "Acme Corporation",
"users": {
"purchased": 5,
"managed": 3,
"viewUrl": "/webclient#/uems/admin/user-administration/users"
},
"acpAddon": {
"devices": {
"purchased": 100,
"managed": 65,
"isShortfall": false
},
"isAddonTrial": false,
"status": true
},
"isLicensePromoted": false,
"dcpAddon": {
"devices": {
"purchased": 100,
"managed": 55,
"isShortfall": false
},
"isAddonTrial": false,
"status": true
},
"smsCredits": {
"purchased": 100,
"managed": 50
},
"osdSystems": {
"servers": {
"purchased": 10,
"managed": 5,
"isShortfall": false
},
"osdComputers": {
"purchased": 50,
"managed": 40,
"isShortfall": false
},
"devices": {
"purchased": 50,
"managed": 40,
"isShortfall": false
},
"osdLicenseEdition": "Enabled",
"osdServers": {
"purchased": 10,
"managed": 5,
"isShortfall": false
},
"isAddonTrial": false,
"status": true
},
"licenseEdition": "Enterprise Edition - Registered Version",
"licenseExpiryDate": "Dec 31, 2030",
"servers": {
"purchased": 10,
"managed": 8,
"viewUrl": "/webclient#/uems/agent/som/computers?deviceType=1"
},
"vmpAddon": {
"devices": {
"purchased": 100,
"managed": 90,
"isShortfall": false
},
"isAddonTrial": false,
"status": true
},
"addonDetails": {
"isBasicTrainingEnabled": false,
"isPremiumSupportEnabled": false,
"isMultiLangEnabled": false
},
"arwAddon": {
"devices": {
"shortfallMessage": "You have 20 more endpoints than purchased.",
"purchased": 100,
"managed": 120,
"isShortfall": true
},
"isAddonTrial": false,
"status": true
},
"storageSpace": {
"purchased": 10,
"managed": "4.76"
},
"eaAddon": {
"devices": {
"purchased": 100,
"managed": 70,
"isShortfall": false
},
"isAddonTrial": false,
"status": true
},
"edrAddon": {
"devices": {
"purchased": 100,
"managed": 50,
"isShortfall": false
},
"isAddonTrial": true,
"status": true
}
}
▼ Show full
Sample Response: HTTP 500
Unexpected server error
Copied!
{
"error_description": "An internal error occurred while processing the request.",
"error_code": 1001
}
▼ Show full
Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes
Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.