Tolgee Octri Demo
PUT/v2/ee-license/set-license-key

Set the EE license key

Sets the EE license key for the instance and returns the resulting subscription details. Supply licenseKey with a non-empty value to apply the key. Use POST /v2/ee-license/prepare-set-license-key first to preview the plan and usage associated with the key.

1 body field

Request to apply an EE license key to the instance.

licenseKeystringrequired
The EE license key to apply. Must contain at least one character.

5 status codes
200Returns the subscription details, including the license key, subscription name and status, enabled features, and current user count.
cancelAtPeriodEndbooleanrequired
currentPeriodEndintegeroptional
currentUserCountintegerrequired
enabledFeaturesarray<string>required
isPayAsYouGobooleanrequired
lastValidCheckstringoptional
licenseKeystringrequired
namestringrequired
nonCommericalbooleanrequired
statusstringrequired
Allowed:ACTIVECANCELEDPAST_DUEUNPAIDERRORTRIALINGKEY_USED_BY_ANOTHER_INSTANCEUNKNOWN
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when access to the requested operation is forbidden.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the requested resource is not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 indicates the request is invalid; a 401 indicates authentication is missing or invalid; a 403 indicates access is forbidden; and a 404 indicates the requested resource was not found. licenseKey is required and must contain at least one character.