Skip to main content
New to Corsair? See API access, authentication, and error handling.

Licensees

create

licensees.create Create a licensee for a product. Risk: write
Input Output

delete

licensees.delete Delete a licensee; forceCascade also deletes its licenses. Risk: destructive
Input Output

get

licensees.get Get one licensee by number. Risk: read
Input Output

list

licensees.list List licensees (the vendor’s customers). Risk: read
Input Output

transfer

licensees.transfer Move every license of a source licensee (marked for transfer) to this licensee; NetLicensing then removes the source licensee. Risk: destructive
Input The source licensee needs markedForTransfer set (licensees.update) and both licensees must belong to the same product. Validating the source clears the flag. After the move NetLicensing removes the source licensee. Output

update

licensees.update Update a licensee. Risk: write
Input Output

validate

licensees.validate Check which product modules a licensee may use; floating checkouts and pay-per-use counts change unless dryRun is true. Risk: destructive
Input Returns one entry per product module with its licensing model and validity, plus ttl, the time until which the result can be reused. Pass module parameters (sessionId and action for Floating, usedQuantity for PayPerUse, nodeSecret for NodeLocked) in parameters. A product with no active module answers 404. Output

Licenses

create

licenses.create Create a license for a licensee from a license template. Risk: write
Input Output

delete

licenses.delete Delete a license. Risk: destructive
Input Output

get

licenses.get Get one license by number. Risk: read
Input Output

list

licenses.list List the vendor’s licenses. Risk: read
Input GET /license. Returns number and active for each license, and stores them locally. Output

update

licenses.update Update a license, for example to deactivate it. Risk: write
Input Output

License Templates

create

licenseTemplates.create Create a license template in a product module. Risk: write
Input licenseType must fit the module model: FEATURE or TIMEVOLUME for TryAndBuy and Rental, TIMEVOLUME for Subscription, FLOATING for Floating, QUANTITY for PayPerUse, Quota and NodeLocked. A price above 0 needs currency. Output

delete

licenseTemplates.delete Delete a license template; forceCascade also deletes its licenses. Risk: destructive
Input Output

get

licenseTemplates.get Get one license template by number. Risk: read
Input Output

list

licenseTemplates.list List license templates. Risk: read
Input Output

update

licenseTemplates.update Update a license template. Risk: write
Input Output

Product Modules

create

productModules.create Create a product module with a licensing model. Risk: write
Input Output

delete

productModules.delete Delete a product module; forceCascade also deletes what depends on it. Risk: destructive
Input Output

get

productModules.get Get one product module by number. Risk: read
Input Output

list

productModules.list List product modules. Risk: read
Input Output

update

productModules.update Update a product module. Risk: write
Input Output

Products

create

products.create Create a product. Risk: write
Input Output

delete

products.delete Delete a product; forceCascade also deletes its modules, templates, licensees and licenses. Risk: destructive
Input Output

get

products.get Get one product by number. Risk: read
Input Output

list

products.list List the vendor’s products. Risk: read
Input GET /product. Returns number, active, name and version, and stores them locally. Output

update

products.update Update a product; fields left out stay as they are. Risk: write
Input Output

Transactions

get

transactions.get Get one transaction by number. Risk: read
Input Output

list

transactions.list List transactions, newest first. Risk: read
Input Newest first. filter takes licenseeNumber=<n> or shopOnly=true. Output