Skip to main content
Keyzy logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: KEYZY
  • Version: 20261030_00

Tools

Slug: KEYZY_DELETE_ACTIVATIONPermanently and irreversibly delete an activation record by its numeric ID using a write-enabled App Key. This operation cannot be undone.

Input Parameters

integer
required
Numeric activation record ID to permanently and irreversibly delete. This operation cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_DELETE_LICENSEPermanently delete a Keyzy license and all activation records associated with it. This cascading deletion is irreversible. Confirm the serial and current license type before calling. Requires a write-enabled App Key.

Input Parameters

string
required
License serial number to permanently delete. This irreversible operation also deletes every activation associated with the license.
string ("perpetual" | "subscription" | "trial")
required
Current license type, used by Keyzy as a deletion safety match. Must be perpetual, subscription, or trial.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_DOWNLOAD_ENCRYPTED_LICENSE_FILEActivate or renew a semi-online Keyzy license and download its encrypted offline license file. A new host can consume an activation slot, and a repeat download resets the file’s offline-license lifetime.

Input Parameters

string
required
License serial number.
string
Device host identifier. Supplying a new host can create or refresh a semi-online activation and consume a device slot.
string
Optional human-readable device label.
string
required
Keyzy product code for the encrypted license file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_GET_LICENSEReturn customer, SKU, type, registration, and validity-period details for one license serial.

Input Parameters

string
required
License serial number to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_LIST_ACTIVATIONSReturn all activation records associated with one license serial number.

Input Parameters

string
required
License serial number whose activations should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_LIST_LICENSE_PRODUCTSReturn the products associated with a license serial, including product codes needed for validation. Keyzy requires a write-enabled App Key for this endpoint.

Input Parameters

string
required
License serial number whose products should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_PREVIEW_DEALER_LICENSE_REGISTRATIONCheck an unregistered dealer license and return the customer-registration details before submitting them.

Input Parameters

string
required
Unregistered dealer license serial number to preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_REGISTER_DEALER_LICENSEPreview an offline dealer license, verify its SKU, then irreversibly register it to a customer as the license owner. The registration cannot be undone through this toolkit.

Input Parameters

string
Optional customer name used only for the irreversible registration.
string
required
Customer email address used only for the irreversible registration.
string
required
Unregistered dealer license serial number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_REGISTER_LICENSEAssign an available license for an SKU to a customer and return the new serial number. If license-email delivery is enabled for the SKU, Keyzy may also email the license information to the customer. Requires a write-enabled App Key.

Input Parameters

string
required
Customer or licensee name.
string
required
Customer or licensee email address.
integer
Unix end timestamp. Required with start_at for subscription or trial licenses.
integer
Unix start timestamp. Required with end_at for subscription or trial licenses.
string
required
SKU number whose available license should be assigned.
string ("perpetual" | "subscription" | "trial")
License type. Omit to use Keyzy’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_UPDATE_ACTIVATIONActivate or deactivate an existing activation record by numeric ID. Set activated to true to enable the record, or false to disable it without deleting it. Requires a write-enabled App Key.

Input Parameters

boolean
required
Desired activation state: true activates the record and allows it to be used; false deactivates the record without deleting it.
integer
required
Numeric activation record ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_UPDATE_LICENSE_SKUMove a license to a new SKU, changing its license type to the destination SKU’s type. Moving to a trial or subscription SKU may require a separate license-term update. Requires a write-enabled App Key.

Input Parameters

string
required
License serial number to move.
string
required
Destination SKU number.
string
required
License’s current SKU number, used as a safety check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_UPDATE_LICENSE_TERMUpdate the validity start and/or required end time of a subscription or trial license. Requires a write-enabled App Key.

Input Parameters

integer
required
New license end time as a Unix timestamp.
string
required
Subscription or trial license serial number.
integer
Optional new license start time as a Unix timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_UPGRADE_LICENSEIrreversibly exchange a current license for an upgrade license. WARNING: when Keyzy confirms success, it permanently deletes the current license and makes the upgrade license usable. Use only after confirming both serials and that deleting the current license is intended.

Input Parameters

string
required
Current license serial to exchange. WARNING: after a successful upgrade, Keyzy permanently deletes this license, so it cannot be used again.
string
required
Upgrade-license serial that becomes usable after the exchange. Confirm it is the intended replacement before calling because the exchange deletes current_serial.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYZY_VALIDATE_LICENSEValidate a Keyzy license for a product. Supplying host_id can create or refresh a device activation and consume an activation slot.

Input Parameters

string
required
License serial number to validate.
string
Stable device host identifier. Supplying a new host can create or refresh an activation and consume a device slot.
string
Optional human-readable device label.
string
required
Keyzy product code to validate against.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not