---
title: "Get the next License."
slug: "get-the-next-license-1"
updated: 2026-03-02T22:30:52Z
published: 2026-03-02T22:35:52Z
canonical: "support.appgate.com/get-the-next-license-1"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://support.appgate.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get the next License.
Get/license/next
Get the next License which will be activated when CA certificate switch occurs. Licenses are bound to the CA Certificate.
SecurityHTTPType bearer
Responses200
License details including usage.
Expand Allobject
License details and current usage.
licenses Array of object (License) object maxUsersnumber
The maximum users allowed by the license.
Example200.0
maxPortalUsersnumber
The maximum Portal users allowed by the license.
Example200.0
maxServiceUsersnumber
The maximum Service users allowed by the license.
Example200.0
usersLeaseTimeHoursnumber
Number of hours User Licenses will be reserved for users before they are reclaimable by others.
Example720.0
portalUsersLeaseTimeHoursnumber
Number of hours User Licenses will be reserved for Portal users before they are reclaimable by others.
Example720.0
serviceUsersLeaseTimeHoursnumber
Number of hours User Licenses will be reserved for Service users before they are reclaimable by others.
Example720.0
maxSitesnumber
The maximum sites allowed by the license. If it's the usage details, then it's the amount of sites in the system at present.
Example5.0
maxAccessPoliciesnumber
The maximum access policies allowed by the license. If it's the usage details, then it's the amount of access policies in the system at present.
Example5.0
maxConnectorGroupsnumber
The maximum Connector groups allowed by the license.
Example150.0
riskEngineboolean
Whether the Risk Engine feature is enabled.
applicationDiscoveryboolean
Whether the Application Discovery feature is enabled.
digitalExperienceMonitoringboolean
Whether the Digital Experience Monitoring feature is enabled.
verifiedDnsNamesobject names Array of string
The DNS names allowed by the license.
string
hashes Array of string
The DNS names' hashes allowed by the license.
string
idstring (uuid)
Unique ID for the license.
Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
versionnumber
License version. There can be only one v1 License in the system, while v2 Licenses can be added as extra.
Example2.0
typenumber
Type of the license. 1: production, 2: installation, 3: test, 4: built-in, 5: aws built-in, 6: metered
Example2.0
requeststring
Request code for the license. If built-in license is in place, use this code to get a license. It's based on the CA certificate.
Example1675ab19fe2
expirationstring (date-time)
The expiration date of the license.
errorstring
Error message if the License is not invalid.
ExampleLicense has expired.
entitledobject (LicenseEntitlement)
License entitlement details.
maxUsersnumber
The maximum users allowed by the license.
Example200.0
maxPortalUsersnumber
The maximum Portal users allowed by the license.
Example200.0
maxServiceUsersnumber
The maximum Service users allowed by the license.
Example200.0
usersLeaseTimeHoursnumber
Number of hours User Licenses will be reserved for users before they are reclaimable by others.
Example720.0
portalUsersLeaseTimeHoursnumber
Number of hours User Licenses will be reserved for Portal users before they are reclaimable by others.
Example720.0
serviceUsersLeaseTimeHoursnumber
Number of hours User Licenses will be reserved for Service users before they are reclaimable by others.
Example720.0
maxSitesnumber
The maximum sites allowed by the license. If it's the usage details, then it's the amount of sites in the system at present.
Example5.0
maxAccessPoliciesnumber
The maximum access policies allowed by the license. If it's the usage details, then it's the amount of access policies in the system at present.
Example5.0
maxConnectorGroupsnumber
The maximum Connector groups allowed by the license.
Example150.0
riskEngineboolean
Whether the Risk Engine feature is enabled.
applicationDiscoveryboolean
Whether the Application Discovery feature is enabled.
digitalExperienceMonitoringboolean
Whether the Digital Experience Monitoring feature is enabled.
verifiedDnsNamesobject names Array of string
The DNS names allowed by the license.
string
hashes Array of string
The DNS names' hashes allowed by the license.
string
requestCodestring
Request code for the license. Use this code to get a license. It's based on the CA certificate.
usageobject
License usage information.
usersnumber
The amount of licensed users in the system at present.
Example152.0
portalUsersnumber
The amount of licensed portal users in the system at present.
Example24.0
serviceUsersnumber
The amount of licensed service users in the system at present.
Example2.0
sitesnumber
The amount of Sites in the system at present.
Example3.0
connectorGroupsnumber
The amount of grouped Connector clients in the system at present.
Example4.0
multiUserClientsnumber
The amount of licensed multi-user clients in the system at present.
Example10.0
clientTypesobject
Counts of the current client types in the system at present.
fullnumber
The amount of full client types in the system at present.
Example10.0
full_multinumber
The amount of full multi client types in the system at present.
Example10.0
full_always_onnumber
The amount of full always on client types in the system at present.
Example10.0
litenumber
The amount of lite client types in the system at present.
Example10.0
headlessnumber
The amount of headless client types in the system at present.
Example10.0
headless_always_onnumber
The amount of full always on client types in the system at present.
Example10.0
connectornumber
The amount of connector client types in the system at present.
Example10.0
ssonumber
The amount of sso client types in the system at present.
Example10.0
webnumber
The amount of web client types in the system at present.
Example10.0
unknownnumber
The amount of unknown client types in the system at present.
Example10.0
mfaProvidersnumber
The amount of non-built-in MFA Providers in the system at present.
Example1.0
deviceScriptsnumber
The amount of non-built-in Device Claim Scripts in the system at present.
Example3.0
criteriaScriptsnumber
The amount of non-built-in Criteria Scripts in the system at present.
Example3.0
entitlementScriptsnumber
The amount of non-built-in EntitlementScripts in the system at present.
Example3.0
userScriptsnumber
The amount of non-built-in User Claim Scripts in the system at present.
Example3.0
fallbackSitesnumber
The amount of fallback Sites in the system at present.
Example1.0
nearestSitesnumber
The amount of nearest Sites in the system at present.
Example1.0
localSitesnumber
The amount of local Sites in the system at present.
Example1.0
profileGroupsnumber
The amount of Profile Groups in the system at present.
Example2.0
applianceCustomizationsnumber
The amount of Appliance Customizations in the system at present.
Example2.0
ringfenceRulesnumber
The amount of non-built-in Ringfence Rules in the system at present.
Example2.0
otpSeedsnumber
The amount of Time-based OTP Seeds in the system at present.
Example2.0
fido2Devicesnumber
The amount of FIDO2 devices in the system at present.
Example2.0
sitesConnectedViaBrokernumber
The amount of sites Connection Brokers are connected to.
Example2.0
identityProvidersobject
The amount of non-built-in Identity Providers in the system at present broken out by type.
ldapnumber
ldapCertificatenumber
radiusnumber
samlnumber
oidcnumber
policiesobject
The amount of Policies in the system at present broken out by type.
accessnumber
stopnumber
devicenumber
dnsnumber
adminnumber
mixednumber
riskModelboolean
Whether the risk model is utilized or not.
geoLocationUpdatesstring
GeoIP provider in use.
Valid values[
"Disabled",
"Default",
"Maxmind",
"IPInfo",
"Custom"
]ExampleDefault
401
Token error. Login again.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
403
Insufficient permissions to access this resource.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
406
Invalid 'Accept' header.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
422
Request validation error. Check "errors" array for details.
Expand Allobject
Http 422 error for object validation.
idstring
Machine readable error code.
messagestring
Human readable error details.
errors Array of object
List of fields with validation errors.
object fieldstring
Name of the field that failed validation.
Examplename
messagestring
Failure reason.
Examplemay not be null
500
Unexpected server side error.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.