Rotate license key

Rotates the license key. Existing key becomes invalid immediately.

POST/v3/licenses/{id}/rotate
JWTlicense:write

Path parameters

idstringrequired

Request body

keystring

The replacement key for the license. If left empty, a key is auto-generated.

Length: [16,256]

keyPatternstring

Regex pattern used to generate the new key when CryptlexWebApi.RequestModels.LicenseKeyRotateRequestModel.Key is omitted. If omitted, the product's license template key pattern is used.

Length: [0,256]

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

keystringrequired
revokedbooleanrequired
suspendedbooleanrequired
perpetualbooleanrequired
totalActivationsintegerrequired

Format: int32

totalDeactivationsintegerrequired

Format: int32

fingerprintMatchingStrategystringrequired

Allowed values: fuzzy, exact, loose

allowedActivationsintegerrequired

Format: int32

allowedDeactivationsintegerrequired

Format: int32

typestringrequired

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

allowedFloatingClientsintegerrequired

Format: int32

serverSyncGracePeriodintegerrequired

Format: int32

serverSyncIntervalintegerrequired

Format: int32

allowedClockOffsetintegerrequired

Format: int32

cryptoBindingEnabledbooleanrequired
expiringSoonEventOffsetintegerrequired

Format: int32

leaseDurationintegerrequired

Format: int32

leasingStrategystringrequired

Allowed values: per-machine, per-instance

allowVmActivationbooleanrequired
allowContainerActivationbooleanrequired
allowClientLeaseDurationbooleanrequired
userLockedbooleanrequired
requireAuthenticationbooleanrequired
disableGeoLocationbooleanrequired
productIdstringrequired
additionalUserIdsarray of stringrequired
allowedIpRangesarray of stringrequired
allowedIpAddressesarray of stringrequired
disallowedIpAddressesarray of stringrequired
allowedCountriesarray of stringrequired
disallowedCountriesarray of stringrequired
metadataarray of objectrequired
customAttributesarray of objectrequired
meterAttributesarray of objectrequired
tagsarray of stringrequired
subscriptionIntervalstring
subscriptionStartTriggerstring

Allowed values: creation, activation

effectiveDatestring

Format: date-time

expiresAtstring

Format: date-time

activatedAtstring

Format: date-time

lastUsedAtstring

Format: date-time

notesstring
entitlementSetIdstring
productVersionIdstring
maintenancePolicyIdstring
maintenanceExpiresAtstring

Format: date-time

currentReleaseVersionstring
maxAllowedReleaseVersionstring
organizationIdstring
organizationobject
userIdstring
userobject
resellerIdstring
resellerobject
allowedIpRangestring