Create a license template

Creates a new license template.

POST/v3/license-templates
JWTlicenseTemplate:write

Request body

namestringrequired

Name of the policy. Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Length: [1,256]Pattern: ^(?!\s)(?!.*\s$)[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$

fingerprintMatchingStrategystringrequired

Strategy for matching machine fingerprint.

Allowed values: fuzzy, exact, loose

allowVmActivationbooleanrequired

Whether to allow an activation inside a virtual machine.

allowContainerActivationbooleanrequired

Whether to allow an activation inside a container.

userLockedbooleanrequired

Locks the activation to the machine user.

disableGeoLocationbooleanrequired

Whether IP address and geo-location should be stored.

allowedActivationsintegerrequired

Allowed number of activations for the license. Set to 0 or -1 for unlimited activations.

Range: [-1, 2147483647]Format: int32

allowedDeactivationsintegerrequired

Allowed number of deactivations for the license. Set to -1 for unlimited deactivations. This setting is ignored for floating licenses.

Range: [-1, 2147483647]Format: int32

typestringrequired

Type of the license key.

Allowed values: node-locked, hosted-floating, on-premise-floating

allowClientLeaseDurationbooleanrequired

Allow client to set the lease duration for floating licenses.

serverSyncGracePeriodintegerrequired

The duration for which the server sync failure due to network error is acceptable. Set to -1 for unlimited grace period.

Range: [-1, 2147483647]Format: int32

serverSyncIntervalintegerrequired

The interval at which license data in client is synced with the server.

Range: [180, 2147483647]Format: int32

allowedClockOffsetintegerrequired

The allowed clock offset between the network time and the local time. Set to -1 to disable clock validation checks.

Range: [-1, 2147483647]Format: int32

cryptoBindingEnabledbooleanrequired

Whether crypto binding is enabled for the license.

expiringSoonEventOffsetintegerrequired

The number of seconds to wait before license expiration date to trigger 'license.expiring-soon' webhook event.

Range: [0, 2147483647]Format: int32

allowedIpRangesarray of string

Allowed IP ranges. Leave empty to ignore.

allowedCountriesarray of string

List of the allowed countries. Leave empty to ignore.

disallowedCountriesarray of string

List of the disallowed countries. Leave empty to ignore.

allowedIpAddressesarray of string

List of the allowed ip addresses. Leave empty to ignore.

disallowedIpAddressesarray of string

List of the disallowed ip addresses. Leave empty to ignore.

subscriptionIntervalstring

The length of time which determines the subscription renewal cadence. ISO8601 durations accepted. Examples: - P1Y (1 year) - P6M (6 months) - P1M (1 month) - P1W (1 week) - P7D (7 days) - PT24H (24 hours)

Length: [1,256]

subscriptionStartTriggerstring

Allowed values: creation, activation

keyPatternstring

Regex for the license key pattern.

Length: [0,256]

leaseDurationinteger

Duration of lease for floating licenses. Set to 0 or -1 for unlimited lease duration.

Range: [-1, 2147483647]Format: int32

leasingStrategystring

Leasing strategy for floating licenses.

Allowed values: per-machine, per-instance

allowedFloatingClientsinteger

Allowed number of floating clients for the On-Premise LexFloatServer.

Range: [0, 2147483647]Format: int32

requiredMetadataKeysarray of string

List of required metadata keys which a license must have.

requiredMeterAttributesarray of string

List of required meter attributes which a license must have.

Response

201 Created

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
allowVmActivationbooleanrequired
allowContainerActivationbooleanrequired
userLockedbooleanrequired
disableGeoLocationbooleanrequired
allowedIpRangesarray of stringrequired
allowedCountriesarray of stringrequired
disallowedCountriesarray of stringrequired
allowedIpAddressesarray of stringrequired
disallowedIpAddressesarray of stringrequired
fingerprintMatchingStrategystringrequired

Allowed values: fuzzy, exact, loose

allowedActivationsintegerrequired

Format: int32

allowedDeactivationsintegerrequired

Format: int32

typestringrequired

Allowed values: node-locked, hosted-floating, on-premise-floating

keyPatternstringrequired
leaseDurationintegerrequired

Format: int32

allowClientLeaseDurationbooleanrequired
leasingStrategystringrequired

Allowed values: per-machine, per-instance

allowedFloatingClientsintegerrequired

Format: int32

serverSyncGracePeriodintegerrequired

Format: int32

serverSyncIntervalintegerrequired

Format: int32

cryptoBindingEnabledbooleanrequired
allowedClockOffsetintegerrequired

Format: int32

expiringSoonEventOffsetintegerrequired

Format: int32

requireAuthenticationbooleanrequired
requiredMetadataKeysarray of stringrequired
requiredMeterAttributesarray of stringrequired
allowedIpRangestring
subscriptionIntervalstring
subscriptionStartTriggerstring

Allowed values: creation, activation