Retrieve endpoint-centric license counts

Returns an endpoint-focused subset of Get License Details -- only resource counts (computers, servers, endpoints). Use this lighter API when only device counts are needed.

Endpoints

get /dcapi/license/endpoints

Copy full URL

Request URL

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

Scope

Admin.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/licenseEndpointsDetails.v1+jsonCopied!

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/dcapi/license/endpoints \
  --header 'Accept: application/licenseEndpointsDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/dcapi/license/endpoints"))
        .header("Accept", "application/licenseEndpointsDetails.v1+json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = {
    'Accept': "application/licenseEndpointsDetails.v1+json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/license/endpoints", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/licenseEndpointsDetails.v1+json");

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/license/endpoints"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/licenseEndpointsDetails.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/license/endpoints' -Method GET -Headers $headers

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.

trialDaysLeftlong

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

payNowstring

CTA text for purchasing the promoted license. Included only when isLicensePromoted is true.

downgradeNowstring

CTA text for reverting to the previous edition. Included only when isLicensePromoted is true.

Actionstring

Action identifier for the downgrade button. Included only when isLicensePromoted is true.

subscriptionFrequencystring

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

licenseExpiryDatestring

Formatted expiry date for registered licenses. Absent for free and trial licenses.

endpointsJSON Object

Endpoint license details with purchased count, managed count, and 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').

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.

serversJSON Object

Server license details with purchased count, managed count, and 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').

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.

- HTTP code 500

Response Body - application/json

JSON Object

Hide Sub-Attributes

error_codeinteger

Error code. 1001 indicates an unexpected failure while fetching license endpoint details.

error_descriptionstring

Human-readable error message describing the failure.

Possible Response Codes

200HTTP code

500HTTP code

Sample Response: HTTP 200

Registered UEM/Security license with no shortfall -- server splitup present with compact 2-entry format

Copied!

  {
    "licenseExpiryDate": "Dec 31, 2030",
    "endpoints": {
      "purchased": 250,
      "managed": 200,
      "viewUrl": "/webclient#/uems/agent/som/computers?deviceType=2",
      "splitDetails": {
        "managedComputersDetails": [
          {
            "count": 150,
            "label": "Agent installed"
          },
          {
            "count": 25,
            "label": "OS Deployed and agent installed"
          }
        ],
        "managedComputers": 150,
        "managedOSDComputers": 25,
        "managedMDMDevices": 25,
        "title": "Managed computer splitup:"
      }
    },
    "servers": {
      "purchased": 10,
      "managed": 12,
      "viewUrl": "/webclient#/uems/agent/som/computers?deviceType=1",
      "splitDetails": {
        "managedServersDetails": [
          {
            "count": 8,
            "label": "Agent installed"
          },
          {
            "count": 2,
            "label": "OS Deployed and agent installed"
          }
        ],
        "title": "Managed servers splitup:",
        "managedOSDServers": 2,
        "managedServers": 10
      }
    },
    "subscriptionFrequency": "YEARLY",
    "isLicensePromoted": false
  }

▼ Show full

Registered UEM/Security license with endpoint shortfall overflowing into servers -- expanded 3-entry server split with managedEndpoints

Copied!

  {
    "licenseExpiryDate": "Dec 31, 2030",
    "endpoints": {
      "purchased": 250,
      "managed": 250,
      "viewUrl": "/webclient#/uems/agent/som/computers?deviceType=2",
      "splitDetails": {
        "managedComputersDetails": [
          {
            "count": 180,
            "label": "Agent installed"
          },
          {
            "count": 55,
            "label": "OS Deployed and agent installed"
          }
        ],
        "managedComputers": 180,
        "managedOSDComputers": 55,
        "serverUsedForEndpoint": true,
        "managedMDMDevices": 25,
        "title": "Managed computer splitup:"
      }
    },
    "servers": {
      "purchased": 10,
      "managed": 22,
      "viewUrl": "/webclient#/uems/agent/som/computers?deviceType=1",
      "splitDetails": {
        "labelhelper": "To free up a Server license, consider purchasing 10 additional Endpoint licenses.",
        "managedServersDetails": [
          {
            "count": 8,
            "label": "Agent installed"
          },
          {
            "count": 2,
            "label": "OS Deployed and agent installed"
          },
          {
            "count": 2,
            "label": "OS Deployed-only Servers"
          }
        ],
        "managedEndpointsDetails": [
          {
            "count": 5,
            "label": "Agent installed"
          },
          {
            "count": 5,
            "label": "OS Deployed and agent installed"
          }
        ],
        "title": "Managed servers splitup:",
        "managedEndpoints": 10,
        "managedServers": 22
      }
    },
    "subscriptionFrequency": "YEARLY",
    "isLicensePromoted": false
  }

▼ Show full

Free edition with minimal endpoint counts -- no splitDetails, no servers

Copied!

  {
    "endpoints": {
      "purchased": 25,
      "managed": 20,
      "viewUrl": "/webclient#/uems/agent/som/computers?deviceType=2"
    },
    "subscriptionFrequency": "YEARLY",
    "isLicensePromoted": false
  }

▼ Show full

Sample Response: HTTP 500

Unexpected server error while fetching license endpoint 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.