# Get Entitlement Summaries (deprecated) Retrieves summarized entitlement utilization data for the authenticated tenant, providing an overview of license usage and availability. This method will be removed no sooner than 08/31/2026. The following endpoint /entitlements/utilizations/query can be used for this content. Endpoint: GET /entitlements/summaries Version: v0.2.0 ## Query parameters: - `refresh` (boolean) - `type` (string) Filter by device type (optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS. Enum: "IOT_CTRL", "UNASSIGNED_DEVICE_TYPE", "WIFI", "LTE", "SWITCH", "ANALYTICS", "RWG", "EDGE", "VIRTUAL_EDGE", "APSW", "EDGE_SECS", "EDGE_SECL", "SLTN_PIN_FOR_IDENTITY", "SLTN_TOKEN", "SLTN_PMS_INTEGRATION" - `licenseType` (string) Filter by license type (optional) Enum: "UNKNOWN", "APSW", "URLF", "EDGE_SECS", "EDGE_SECL", "SLTN_TOKEN" ## Response 200 fields (application/json): - `banners` (array) Collection of license banner notifications containing alerts, warnings, and informational messages related to license status, expiration, and compliance. - `banners.alm` (boolean) Indicates whether this banner is related to ALM (advanced license management) features and functionality. - `banners.almExtraInfo` (object) Additional ALM entitlement information including license types, quantities, and remaining capacity for advanced license management scenarios. - `banners.almExtraInfo.licenseType` (string) Type of license in the ALM system, categorizing the specific license classification for entitlement management. Enum: "UNKNOWN", "APSW", "URLF", "EDGE_SECS", "EDGE_SECL", "SLTN_TOKEN" - `banners.almExtraInfo.remainingQuantity` (integer) Remaining license quantity available for this license type, indicating how many licenses are still unused or unassigned. - `banners.almExtraInfo.soEntQuantity` (integer) Total licensed daily device count in the sales order, representing the complete entitlement quantity from the original sales order. - `banners.deviceCount` (integer) Total number of devices covered by the license associated with this banner, representing licensed device capacity. - `banners.deviceSubType` (string) Specific subtype or model classification within the broader device type category, providing more granular device identification. - `banners.deviceType` (string) Type of devices covered by this license banner, such as access points, switches, or analytics devices. Enum: "IOT_CTRL", "UNASSIGNED_DEVICE_TYPE", "WIFI", "LTE", "SWITCH", "ANALYTICS", "RWG", "EDGE", "VIRTUAL_EDGE", "APSW", "EDGE_SECS", "EDGE_SECL", "SLTN_PIN_FOR_IDENTITY", "SLTN_TOKEN", "SLTN_PMS_INTEGRATION" - `banners.effectDate` (string) The effective date when the license condition described in this banner takes effect, such as expiration date or grace period end. - `banners.effectDays` (integer) Number of days until the effective date is reached, providing countdown information for license expiration or other time sensitive conditions. - `banners.licenseType` (string) License type classification indicating the specific licensing model or category applicable to this banner notification. Enum: "UNKNOWN", "APSW", "URLF", "EDGE_SECS", "EDGE_SECL", "SLTN_TOKEN" - `banners.multipleLicense` (boolean) Indicates whether multiple license types or entitlements are involved in this banner notification scenario. - `banners.totalActiveDevices` (integer) Total count of currently active devices across all device types including access points, switches, and edge devices. - `banners.totalRALicense` (integer) Total number of ruckus analytics licenses available, for tracking and notifications. - `banners.type` (string) Enum: "INITIAL", "CLOSE_TO_EXPIRATION", "GRACE_PERIOD", "AFTER_GRACE_PERIOD", "RA_BELOW_90_PERCENT_OF_DEVICES", "RA_BELOW_50_PERCENT_OF_DEVICES", "RA_ONBOARD_ONLY" - `entitlements` (array) List of entitlement objects containing detailed license information including quantities, dates, SKUs, and device types. - `entitlements.alm` (boolean) Flag indicating whether this entitlement is managed by ALM (application license management) system. - `entitlements.almActivationId` (string) Activation identifier used for license activation and tracking within the application license management system. - `entitlements.almLicenseType` (string) Specific license type classification, providing additional categorization for application license management. Enum: "UNKNOWN", "APSW", "URLF", "EDGE_SECS", "EDGE_SECL", "SLTN_TOKEN" - `entitlements.almSoEntQuantity` (integer) Sales order entitlement quantity, representing the total quantity allocated from the sales order in the ALM system. - `entitlements.almUsedQuantity` (integer) Used quantity, indicating how many licenses from this entitlement are currently in use within the ALM system. - `entitlements.assignedLicense` (boolean) Flag indicating whether this entitlement is an assigned license, typically generated by entitlement assignment service for MSP assignments. - `entitlements.createdDate` (string) Timestamp when the entitlement record was created in the system. - `entitlements.deviceSubType` (string) Device subtype classification providing additional categorization beyond the main device type. - `entitlements.deviceType` (string) Type of device that this entitlement applies to, determining the category of hardware or software that can use this license. Enum: "IOT_CTRL", "UNASSIGNED_DEVICE_TYPE", "WIFI", "LTE", "SWITCH", "ANALYTICS", "RWG", "EDGE", "VIRTUAL_EDGE", "APSW", "EDGE_SECS", "EDGE_SECL", "SLTN_PIN_FOR_IDENTITY", "SLTN_TOKEN", "SLTN_PMS_INTEGRATION" - `entitlements.effectiveDate` (string) Date when the entitlement becomes active and can be used, marking the start of the license validity period. - `entitlements.emailStage` (string) Current stage of email notifications for the license, tracking the life cycle stage for notification purposes. - `entitlements.expirationDate` (string) Date when the entitlement expires and is no longer valid for use, marking the end of the license validity period. - `entitlements.extendedLicensesAssignment` (boolean) Flag indicating whether this entitlement represents an extended licenses assignment, identified by specific SKU suffix patterns. - `entitlements.externalId` (string) External identifier for the entitlement, typically the system entitlement ID from external licensing systems and third party vendors. - `entitlements.graceEndDate` (string) Grace period end date for the entitlement, calculated based on expiration date plus grace duration, with special handling for temporary and assigned licenses. - `entitlements.historical` (boolean) Flag indicating whether this entitlement is historical (expired), determined by checking expiration status without grace period. - `entitlements.id` (string) - `entitlements.licenseDesc` (string) Detailed description of the license, providing additional information about the entitlement's purpose and features. - `entitlements.licenseName` (string) Human-readable name of the license, providing a descriptive title for the entitlement. - `entitlements.mspSku` (boolean) Flag indicating whether this entitlement is an MSP (Managed Service Provider) SKU, used for filtering MSP specific licenses. - `entitlements.parentId` (string) The identifier of the parent entity in the entity hierarchy. Returns null for top level entities that have no parent. - `entitlements.quantity` (integer) Number of licenses granted by this entitlement, representing the quantity of devices or users that can use this license. - `entitlements.r1Sku` (boolean) Flag indicating whether this entitlement uses an R1 SKU format, determined by specific SKU naming patterns. - `entitlements.sku` (string) Stock keeping unit identifier for the license, uniquely identifying the product and license type in the system. - `entitlements.skuTier` (string) Tier classification providing additional product hierarchy information for the license. - `entitlements.tempLicense` (boolean) Flag indicating whether this is a temporary license, determined by ALM status, SKU pattern, and device type. - `entitlements.updatedDate` (string) Timestamp when the entitlement record was last updated in the system. - `summary` (array) Collection of entitlement operation summaries providing aggregated license information, usage statistics, and compliance details. - `summary.activeDeviceCountMap` (object) Map of active device counts by device type, providing detailed breakdown of license usage across different device categories. - `summary.alm` (boolean) Flag indicating whether this entitlement is managed by ALM (application license management) system. - `summary.almExtraInfo` (object) Additional ALM (application license management) specific entitlement information, only valid when alm flag is true, containing license type and quantity details. - `summary.assignedLicenses` (integer) Total number of assigned licenses currently allocated to devices or users. - `summary.availablePaidQuantityForMspEcs` (integer) Available paid license quantity for MSP enterprise customers, negative values indicate license shortfall. - `summary.availableTrialQuantityForMspEcs` (integer) Available trial license quantity for MSP enterprise customers, negative values indicate license shortfall. - `summary.closestLiceseQtty` (integer) Quantity of the next expiring licenses, indicating how many licenses will expire soonest. - `summary.courtesyQuantity` (integer) Courtesy license quantity, valid only for MSP/VAR tenants when consolidated SKU feature flag is enabled. - `summary.deviceCount` (integer) Total number of devices currently using licenses, representing actual license consumption. - `summary.deviceSubType` (string) Device subtype providing additional categorization beyond the main device type. - `summary.deviceType` (string) Type of device that this entitlement applies to, determining the category of hardware or software for license usage. Enum: "IOT_CTRL", "UNASSIGNED_DEVICE_TYPE", "WIFI", "LTE", "SWITCH", "ANALYTICS", "RWG", "EDGE", "VIRTUAL_EDGE", "APSW", "EDGE_SECS", "EDGE_SECL", "SLTN_PIN_FOR_IDENTITY", "SLTN_TOKEN", "SLTN_PMS_INTEGRATION" - `summary.effectiveDate` (string) Date when the entitlement becomes active and available for use. - `summary.errorCode` (string) Error code indicating any issues or problems encountered during entitlement operations. - `summary.expirationDate` (string) Date when the entitlement expires and is no longer valid for use. - `summary.futureOfComplianceDate` (string) Date when future compliance issues are projected to occur based on current usage trends. - `summary.futureOutOfComplianceDevices` (integer) Number of devices that will be out of compliance in the future based on projected usage. - `summary.internalMessage` (string) Internal message providing additional details about the entitlement operation status or errors. - `summary.licenseDesc` (string) Detailed description of the license explaining its features and usage. - `summary.licenseName` (string) Human-readable name of the license for display purposes. - `summary.mspEcAssignedLicenses` (integer) Number of licenses assigned to MSP enterprise customers, includes both paid and trial if summary combines them. - `summary.mspEcAssignedTrialLicenses` (integer) Number of trial licenses assigned to MSP enterprise customers, valid when summary combines paid and trial licenses. - `summary.outOfComplianceDevices` (integer) Number of devices currently out of compliance, exceeding available license allocation. - `summary.purchasedLicenses` (integer) Total number of purchased licenses available for allocation. - `summary.quantity` (integer) Total license quantity available, calculated differently for MSP/VAR vs REC/MSP_EC tenants based on purchased licenses and assignments. - `summary.remainingDays` (integer) Number of days remaining until the entitlement expires. - `summary.remainingQuantity` (integer) Number of licenses remaining available for use, calculated based on total quantity minus used licenses. - `summary.remainingQuantityForMspEcs` (integer) Remaining license quantity available for MSP enterprise customers, calculated based on SKU type (trial vs paid) with minimum value of 0. - `summary.sku` (string) Stock keeping unit identifier for the license, uniquely identifying the product and license type. - `summary.tempLicense` (boolean) Flag indicating whether this is a temporary license with limited duration or trial status. - `summary.toBeRemovedDeviceCount` (integer) Number of devices that are scheduled to be removed or decommissioned from license usage. - `summary.totalAvailableQuantityForItself` (integer) Total available quantity for MSP itself including both paid and trial licenses, negative values indicate license shortfall. - `summary.trialQuantity` (integer) Total trial license quantity when summary combines paid and trial licenses. - `summary.closestLicenseQuantity` (integer) Deprecated field for closest license quantity, replaced by closestLiceseQtty. ## Response 202 fields (application/json): - `desc` (string) Human-readable description providing details about the accepted request, its purpose, and expected processing outcome. - `link` (string) URI link for tracking or retrieving the status of the accepted request. - `requestId` (string) Unique identifier assigned to track the accepted request throughout its processing life cycle, enabling status monitoring and correlation with logs. ## Response 404 fields (application/json): - `code` (string) Unique error code identifying the specific type of error that occurred. - `message` (string) Human-readable error message providing details about what went wrong. - `reason` (string) Detailed explanation of why the error occurred, providing additional context. - `suggestion` (string) Actionable suggestion or recommendation for how to resolve or avoid this error.