NinjaOne icon

NinjaOne

Ninja One Public API documentation. <br><br>See also: <br> <a href="https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf">Device Filter syntax</a><br><a href="https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview">Webhooks</a>

Actions309

SoftwareLicenses → Create a Software License

AI-generated

Summary

Create a new software license within the NinjaOne system by specifying detailed attributes such as name, description, type, purchase date, publisher ID, vendor ID, scope, quantity, current usage, term, and notification channel info.

Inputs

  • name (required) — Name of the software license.
  • description (required) — Description of the software license.
  • type (required) — Type of the software license; options include PER_DEVICE, PER_USER, or CUSTOM.
  • purchaseDate (required) — Purchase date of the license as Unix epoch milliseconds.
  • publisherId (required) — Identifier for the publisher of the license.
  • vendorId (required) — Identifier for the vendor of the license.
  • scope (required) — JSON object indicating the scope of the software license.
  • quantity (required) — Quantity of licenses purchased.
  • currentUsage (required) — Current usage count of the software license.
  • term (required) — JSON object defining the term details of the license.
  • notificationChannelInfo (required) — JSON object for notification channel information related to the software license.
  • additionalFields — Optional additional fields including assignment automation settings, assigned/unassigned licenses IDs, notes, cost mode and cost, and usage monitoring configuration.
  • options — Optional request customizations such as custom JSON body, headers, query filters, batching, debugging, pagination, and timeout settings.

Output shape

a single record representing the created software license including all set properties plus server-generated identifiers or metadata

The output includes the full JSON response from the NinjaOne API upon creation. If debugging is enabled, additional details about the HTTP request and response are included. Pagination and batching options apply only to applicable API calls, but this create operation typically returns a single item.

Examples

Example 1: Create a software license with mandatory fields only

Provide name, description, type, purchaseDate, publisherId, vendorId, scope, quantity, currentUsage, term, and notificationChannelInfo.

Links

Discussion