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.

Endpoint

Request URL

https://{serverurl}/dcapi/licenseMeta Copied!

Scope

DesktopCentralCloud.Admin.READCopied!

Header

Authorization: Zoho-oauthtoken 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://appdomains/dcapi/licenseMeta \
  --header 'Accept: application/licenseMeta.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  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.

serversboolean

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

endpointsboolean

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

serversboolean

True if the managed server count has reached or exceeded the purchased server 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.

Sample Response: HTTP 200

All limits within range

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

Limit exceeded

Copied!
  {
    "isLicenseLimitReached": {
      "endpoints": true,
      "servers": 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.