Create a license
Creates a new license.
POST/v3/licenses
JWT
license:write
Request Body Schema
| Property | Type | Description | Constraints |
|---|---|---|---|
| key | string | The key associated with the license. If left empty, key is auto-generated. | min: 16, max: 256 |
| revoked | boolean | Set true to revoke the license. | |
| suspended | boolean | Set true to suspend the license. | |
| fingerprintMatchingStrategy | string | Strategy for matching machine fingerprint. | enum: [fuzzy, exact, loose] |
| allowedActivations | integer | Allowed number of activations for the license. Set to 0 or -1 for unlimited activations. | min: -1, max: 2147483647, format: int32 |
| allowedDeactivations | integer | Allowed number of deactivations for the license. Set to -1 for unlimited deactivations. This setting is ignored for floating licenses. | min: -1, max: 2147483647, format: int32 |
| leaseDuration | integer | Duration of lease for floating licenses. Set to 0 or -1 for unlimited lease duration. | min: -1, max: 2147483647, format: int32 |
| allowClientLeaseDuration | boolean | Allow client to set the lease duration for floating licenses. | |
| allowedFloatingClients | integer | Allowed number of floating clients for the On-Premise LexFloatServer. | min: 0, max: 2147483647, format: int32 |
| serverSyncGracePeriod | integer | The duration for which the server sync failure due to network error is acceptable. Set to -1 for an unlimited grace period. | min: -1, max: 2147483647, format: int32 |
| serverSyncInterval | integer | The interval at which license data in client is synced with the server. | min: 180, max: 2147483647, format: int32 |
| allowedClockOffset | integer | The allowed clock offset between the network time and the local time. Set to -1 to disable clock validation checks. | min: -1, max: 2147483647, format: int32 |
| cryptoBindingEnabled | boolean | Whether crypto binding is enabled for the license. | |
| expiringSoonEventOffset | integer | Specifies the offset in seconds before the license's expiration date or the license's maintenance expiration date at which the 'license.expiring-soon' or 'license.maintenance-expiring-soon' webhook event is triggered. This early warning ensures that clients are alerted in advance to take necessary actions before the license or license maintenance expires. | min: 0, max: 2147483647, format: int32 |
| allowVmActivation | boolean | Indicates whether activation is permitted within a virtual machine environment. Setting this to true allows the license to be activated in virtual machines, which may be necessary for certain deployment scenarios. | |
| allowContainerActivation | boolean | Indicates whether activation is permitted within a container environment. Setting this to true allows the license to be activated in containers, which is essential for modern cloud-native applications. | |
| disableGeoLocation | boolean | Whether IP address and geo-location should be stored. | |
| notes | string | Notes to store with the license. | min: 0, max: 4096 |
| allowedIpRanges | array | Allowed IP ranges. Leave empty to ignore. | items: string |
| allowedCountries | array | List of the allowed countries. Leave empty to ignore. | items: string |
| disallowedCountries | array | List of the disallowed countries. Leave empty to ignore. | items: string |
| allowedIpAddresses | array | List of the allowed ip addresses. Leave empty to ignore. | items: string |
| disallowedIpAddresses | array | List of the disallowed ip addresses. Leave empty to ignore. | items: string |
| userId | string | Unique identifier for the user. | min: 0, max: 256 |
| resellerId | string | Unique identifier for the reseller user. | min: 0, max: 256 |
| organizationId | string | Unique identifier for the organization. | min: 0, max: 256 |
| additionalUserIds | array | Unique identifier for the additional users. | items: string |
| productVersionId | string | Unique identifier for the product version. | min: 0, max: 256 |
| entitlementSetId | string | Unique identifier for the Entitlement Set. | min: 0, max: 256 |
| maintenancePolicyId | string | Unique identifier for the maintenance policy. | min: 0, max: 256 |
| maxAllowedReleaseVersion | string | The max allowed release version. This property is ignored if maintenance policy is set for the license. Only following three formats are allowed x.x, x.x.x, x.x.x.x. | |
| tags | array | List of tags. | items: string |
| metadata | array | List of metdata key/value pairs. | items: object |
| key* | string | Name of the key. | min: 1, max: 256 |
| value* | string | Value of the key. | min: 0, max: 4096 |
| viewPermissions | array | Array of view permissions associated with the metadata. | items: string |
| meterAttributes | array | List of metered attributes. | items: object |
| name* | string | Name of the attribute. | min: 1, max: 256 |
| allowedUses* | integer | Allowed number of uses for the attribute. Set to -1 for unlimited usage. | min: -1, max: 9223372036854776000, format: int64 |
| viewPermissions | array | Array of view permissions associated with the meter. | items: string |
| floating | boolean | Set true to make the meter attribute floating. | |
| subscriptionInterval | string | 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) - PT1H (1 hour) - PT30M (30 minutes) | min: 0, max: 256 |
| subscriptionStartTrigger | string | enum: [creation, activation] | |
| expiresAt | string | Set the EndDate of the License Subscription. | format: date-time |
| leasingStrategy | string | Leasing strategy for hosted-floating and on-premise license. | enum: [per-machine, per-instance] |
| userLocked | boolean | Locks the activation to the machine user. | |
| type | string | Type of the license. | enum: [node-locked, hosted-floating, on-premise-floating] |
| createdAt | string | This property should only be used if importing old licenses. | format: date-time |
| effectiveDate | string | Specifies the date after which the license becomes valid. Defaults to the current date if not set. Use this property to post-date or pre-date a license's usage. | format: date-time |
| productId* | string | Unique identifier for the product. | min: 1, max: 256 |
| licenseTemplateId | string | Unique identifier for the license template. Use this to override the default license template. |
Request Example
Responses
201
400
401
403
409
429
500