New to Corsair? See API access, authentication, and error handling.
Licensees
create
licensees.create
Create a licensee for a product.
Risk: write
Output
item full type
item full type
delete
licensees.delete
Delete a licensee; forceCascade also deletes its licenses.
Risk: destructive
Output
get
licensees.get
Get one licensee by number.
Risk: read
Output
item full type
item full type
list
licensees.list
List licensees (the vendor’s customers).
Risk: read
Output
items full type
items full type
page full type
page full type
transfer
licensees.transfer
Move every license of a source licensee (marked for transfer) to this licensee; NetLicensing then removes the source licensee.
Risk: destructive
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
Output
item full type
item full type
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
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
validations full type
validations full type
Licenses
create
licenses.create
Create a license for a licensee from a license template.
Risk: write
Output
item full type
item full type
delete
licenses.delete
Delete a license.
Risk: destructive
Output
get
licenses.get
Get one license by number.
Risk: read
Output
item full type
item full type
list
licenses.list
List the vendor’s licenses.
Risk: read
GET /license. Returns number and active for each license, and stores them locally.
Output
licenses full type
licenses full type
page full type
page full type
update
licenses.update
Update a license, for example to deactivate it.
Risk: write
Output
item full type
item full type
License Templates
create
licenseTemplates.create
Create a license template in a product module.
Risk: write
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
item full type
item full type
delete
licenseTemplates.delete
Delete a license template; forceCascade also deletes its licenses.
Risk: destructive
Output
get
licenseTemplates.get
Get one license template by number.
Risk: read
Output
item full type
item full type
list
licenseTemplates.list
List license templates.
Risk: read
Output
items full type
items full type
page full type
page full type
update
licenseTemplates.update
Update a license template.
Risk: write
Output
item full type
item full type
Product Modules
create
productModules.create
Create a product module with a licensing model.
Risk: write
Output
item full type
item full type
delete
productModules.delete
Delete a product module; forceCascade also deletes what depends on it.
Risk: destructive
Output
get
productModules.get
Get one product module by number.
Risk: read
Output
item full type
item full type
list
productModules.list
List product modules.
Risk: read
Output
items full type
items full type
page full type
page full type
update
productModules.update
Update a product module.
Risk: write
Output
item full type
item full type
Products
create
products.create
Create a product.
Risk: write
Output
item full type
item full type
delete
products.delete
Delete a product; forceCascade also deletes its modules, templates, licensees and licenses.
Risk: destructive
Output
get
products.get
Get one product by number.
Risk: read
Output
item full type
item full type
list
products.list
List the vendor’s products.
Risk: read
GET /product. Returns number, active, name and version, and stores them locally.
Output
products full type
products full type
page full type
page full type
update
products.update
Update a product; fields left out stay as they are.
Risk: write
Output
item full type
item full type
Transactions
get
transactions.get
Get one transaction by number.
Risk: read
Output
item full type
item full type
list
transactions.list
List transactions, newest first.
Risk: read
Newest first.
filter takes licenseeNumber=<n> or shopOnly=true.
Output
items full type
items full type
page full type
page full type