Skip to content

Activations

Activations let you tie usage to specific units, allowing for node-locked or floating licensing. Adding or removing activations automatically updates the connected License Entitlements's usage.

Get all activations in a License Entitlement

Endpoint: GET https://api.software-licensing.io/v1/activations/license-entitlement/{id}

Parameters(Query)

ts
pageSize?: integer
ts
pageNumber?: integer
ts
search: {
}
ts
sort_by?: string[]

Responses

  • 200 Success

application/json

ts
{
  data: {
    id: string
    value: string
    active: boolean
  }[]
  pagination: {
    itemCount: integer
    totalPages: integer
    currentPage: integer
    nextPage?: integer
    previousPage?: integer
  }
}

Create an activation

Endpoint: POST https://api.software-licensing.io/v1/activations

To add Activations to a License Entitlement, its Measure Unit has to allow activations.

Activation values need to be unique within a License Entitlement.

The number of active activations you can add to a License Entitlement is controlled by its Treshold field.

RequestBody

ts
{
  activationValue: string
  licenseKey: string
  entitlementName: string
}

Responses

  • 201 Returns created License.

application/json

ts
{
  id: string
  value: string
  active: boolean
}

Update an activation by value, name, and license

Endpoint: PUT https://api.software-licensing.io/v1/activations/activation

The number of active Activations you can add to a License Entitlement is controlled by its Threshold field.

RequestBody

ts
{
  activationValue?: string
  licenseKey?: string
  entitlementName?: string
  active?: boolean
}

Responses

  • 204 Activation was update successfully

Delete an activation by value, name, and license

Endpoint: POST https://api.software-licensing.io/v1/activations/activation/delete

RequestBody

ts
{
  activationValue: string
  licenseKey: string
  entitlementName: string
}

Responses

  • 204 Activation was deleted successfully