Check whether any license limits have been reached

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 boolean flags inside isLicenseLimitReached indicating whether resource license limits have been reached.

Endpoints

Request URL

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

Scope

Admin.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

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

Response Parameters

- HTTP code 200

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

Wrapper containing boolean flags for each resource type indicating whether the license limit has been reached.

Show Sub-Attributes
endpointsboolean

True if the managed endpoint count has reached or exceeded the purchased endpoint limit.

computersboolean

True if the managed computer count has reached or exceeded the purchased computer limit.

serversboolean

True if the managed server count has reached or exceeded the purchased server limit.

systemsboolean

True if the managed system count has reached or exceeded the limit.

- HTTP code 500

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

Error code. 1001 indicates an unexpected failure while checking license limits.

error_descriptionstring

Human-readable error message describing the failure.

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

All endpoint limits are within purchased counts

Copied!
  {
    "isLicenseLimitReached": {
      "endpoints": false
    }
  }
                
Show full

Registered license with both endpoint and server limits -- both within purchased counts

Copied!
  {
    "isLicenseLimitReached": {
      "endpoints": false,
      "servers": false
    }
  }
                
Show full

Both endpoint and server limits exceeded -- no server capacity to absorb endpoint overflow

Copied!
  {
    "isLicenseLimitReached": {
      "endpoints": true,
      "servers": true
    }
  }
                
Show full

Computer limit is exceeded while server limit is within range

Copied!
  {
    "isLicenseLimitReached": {
      "servers": false,
      "computers": true
    }
  }
                
Show full

System limit is within purchased counts

Copied!
  {
    "isLicenseLimitReached": {
      "systems": false
    }
  }
                
Show full

Sample Response: HTTP 500

Unexpected server error while checking license limits

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.