Skip to content

Lists active license sessions for the entitlement.

GET
/api/v1/provision/operational/entitlements/{entitlementId}/activations
curl --request GET \
--url https://example.com/api/v1/provision/operational/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/activations
entitlementId
required
string format: uuid

Target entitlement.

pageNumber
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

1-based page index.

pageSize
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

Page size.

sortOrder
string

Optional sort expression.

filter
string

Optional filter expression.

OK

A single page of results from a list endpoint, together with the paging metadata needed to navigate the full result set.

object
pageNumber

The 1-based index of this page within the full result set.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
pageSize

The maximum number of items per page that was requested.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
totalCount

The total number of items across all pages.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
items

The items on this page.

Array<object> | null

Admin read model of a license session: one activated seat (device/process) on an entitlement, with its lease, grace, trial, and validity windows.

object
id
string format: uuid
isTrial
boolean
isValidSession

Computed client-side: lease not expired, still inside the validity window, and not revoked.

boolean
activationTime
string format: date-time
lastAccessTime
string format: date-time
leaseExpiration
string format: date-time
graceExpiration
string format: date-time
leaseTime
string
/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/
trialExpiration
string format: date-time
isRevoked
boolean
fingerprint
string
deviceName

Optional display name of the device where the license is activated. Useful for management UIs and user identification of licensed devices.

null | string
applicationInstanceId

Identifies the specific process that holds this license when concurrent licensing is enabled. Relevant when multiple processes on the same hardware require separate licenses.

null | string
activationCode
string
licenseKey
null | string
entitlementId
string format: uuid
appliedPlanSetId
null | string format: uuid
appliedPlanName
null | string
licensedProducts
Array<string>
cannotActivateBeforeTimestamp
string format: date-time
notValidAfterTimestamp
string format: date-time
userId
string format: uuid
email
string
totalPages

The total number of pages in the result set.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
hasPreviousPage

Whether a page precedes this one.

boolean
hasNextPage

Whether a page follows this one.

boolean

Not Found

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string