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 or Update a Software License

AI-generated

Summary

Create a new software license or update an existing one in NinjaOne by specifying required fields such as name, type, publisher name, vendor name, scope, and quantity, with optional additional details and custom request options.

Inputs

  • name (required) — The name of the software license to create or update.
  • type (required) — The type of the software license, must be one of PER_DEVICE, PER_USER, or CUSTOM.
  • publisherName (required) — The name of the software publisher.
  • vendorName (required) — The name of the software vendor.
  • scope (required) — A JSON object indicating the scope of the software license.
  • quantity (required) — The quantity of licenses available.
  • additionalFields — Optional fields for the software license such as description, purchase date (epoch ms), current usage, lists of current licensees, licensees to assign or remove, notes, cost and cost mode, and usage monitoring configuration.
  • options — Custom request settings including custom request body (JSON), HTTP headers, query filters, batching options, debug mode, pagination configuration, and timeout settings.

Output shape

a single JSON object representing the created or updated software license as returned by the API

The output includes the API response JSON. If debug is enabled, additional debug details about the HTTP request and response are included under a debug entry.

Examples

Example 1: Create a new software license with mandatory fields

Set name, type, publisherName, vendorName, scope, and quantity; leave additionalFields and options empty.

Example 2: Update an existing license to assign new licensees

Include currentLicensees and licenseesToAssign in additionalFields JSON to adjust assigned licensees accordingly.

Links

Discussion