Retrieve full license details including edition, counts, and add-ons

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns the complete license state -- edition, expiry, resource counts, and add-on details. For a lighter endpoint-only view, use Get License Endpoints.

Endpoints

get /dcapi/license

Request URL

https://{server-hostname}:8383/dcapi/license

Scope

Admin.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/licenseDetails.v1+jsonapplication/licenseDetails.v1+jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/license \
  --header 'Accept: application/licenseDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
isLicensePromotedboolean

True when a registered license is running a higher-edition promotional trial. When true, additional keys trialDaysLeft, payNow, downgradeNow, and Action are included in the response.

trialDaysLeftlong

Days remaining in the promotional trial. Included only when isLicensePromoted is true.

payNowstring

CTA text for purchasing the promoted license (e.g. 'Purchase License'). Included only when isLicensePromoted is true.

downgradeNowstring

CTA text for reverting to the previous edition (e.g. 'Retain Enterprise'). Included only when isLicensePromoted is true.

Actionstring

Action identifier for the downgrade button. Value is always 'Downgrade'. Included only when isLicensePromoted is true.

licenseEditionstring

Localized license edition display message (e.g. 'Enterprise Edition - Registered Version', 'Free', 'Security Edition - Trial Version'). Varies by license type and plan.

productNamestring

Product display name (e.g. 'Endpoint Central Cloud').

buildNumberstring

Build-number string (e.g. 11.3.2423.0).

licensedTostring

Company name for registered licenses; username for free/trial licenses.

licenseExpiryDatestring

Formatted expiry date for registered licenses (e.g. 'Dec 31, 2030' or 'Never'). Absent for free and trial licenses.

evaluationDaysLeftstring

String-formatted days remaining for trial licenses (e.g. '22'). Absent for registered and free licenses.

subscriptionFrequencystring

Subscription renewal frequency. Values: 'YEARLY' or 'MONTHLY'.

addonDetailsJSON Object

Add-on enablement status and detailed list including multi-language pack, training, and premium support.

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.

usersJSON Object

Technician/user license details with purchased and managed 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.

endpointsJSON Object

Endpoint license details with purchased count, managed count, and split breakdown. Present when the product supports endpoint counting.

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').

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 details with purchased and managed 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.

serversJSON Object

Server license details with purchased count, managed count, and split breakdown. Present when the product uses server-based licensing.

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').

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').

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 details with purchased (GB) and managed (formatted GB string) values. Present when storage add-on is enabled.

Show Sub-Attributes
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 details with purchased and managed counts. Present when the product supports SMS credits.

Show Sub-Attributes
purchasedinteger

Purchased/allocated count for this resource.

managedstring

Currently used/managed count. String for storage (formatted GB), integer for other resources.

- 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.

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Registered license -- simplest structure with computers key, no servers, no storage, no sms

Copied!
  {
    "licenseEdition": "Enterprise Edition - Registered Version",
    "licenseExpiryDate": "Dec 31, 2030",
    "addonDetails": {
      "isBasicTrainingEnabled": false,
      "isPremiumSupportEnabled": false,
      "isMultiLangEnabled": false
    },
    "subscriptionFrequency": "YEARLY",
    "buildNumber": "11.3.2423.0",
    "productName": "(product-specific)",
    "licensedTo": "Acme Corporation",
    "users": {
      "purchased": 5,
      "managed": 3,
      "viewUrl": "/webclient#/uems/admin/user-administration/users"
    },
    "computers": {
      "purchased": 250,
      "managed": 200,
      "viewUrl": "/webclient#/uems/agent/som/computers?deviceType=2"
    },
    "isLicensePromoted": false
  }
                
Show full

Trial license with computers key

Copied!
  {
    "licenseEdition": "Enterprise Edition - Trial Version",
    "evaluationDaysLeft": "22",
    "addonDetails": {
      "isBasicTrainingEnabled": false,
      "isPremiumSupportEnabled": false,
      "isMultiLangEnabled": false
    },
    "subscriptionFrequency": "YEARLY",
    "buildNumber": "11.3.2423.0",
    "productName": "(product-specific)",
    "licensedTo": "admin",
    "users": {
      "purchased": 1,
      "managed": 1,
      "viewUrl": "/webclient#/uems/admin/user-administration/users"
    },
    "computers": {
      "purchased": 25,
      "managed": 10,
      "viewUrl": "/webclient#/uems/agent/som/computers?deviceType=2"
    },
    "isLicensePromoted": false
  }
                
Show full

Free edition with computers key

Copied!
  {
    "licenseEdition": "Free",
    "addonDetails": {
      "isBasicTrainingEnabled": false,
      "isPremiumSupportEnabled": false,
      "isMultiLangEnabled": false
    },
    "subscriptionFrequency": "YEARLY",
    "buildNumber": "11.3.2423.0",
    "productName": "(product-specific)",
    "licensedTo": "admin",
    "users": {
      "purchased": 1,
      "managed": 1,
      "viewUrl": "/webclient#/uems/admin/user-administration/users"
    },
    "computers": {
      "purchased": 25,
      "managed": 20,
      "viewUrl": "/webclient#/uems/agent/som/computers?deviceType=2"
    },
    "isLicensePromoted": false
  }
                
Show full

Sample Response: HTTP 500

Unexpected server error while fetching license details

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.