# Entitlements Overview The Manage Entitlement API provides comprehensive capabilities for managing entitlements within the RUCKUS One platform. Entitlements represent the authorization and rights to use RUCKUS products and services, encompassing licenses, subscriptions. This API enables you to manage these entitlements, track their usage, control assignments to partners and customers, and monitor compliance. The API is designed for organizations that need to manage entitlements including licenses and subscriptions, track device usage, allocate entitlements to customers or partners, and maintain compliance with subscription agreements. What This API Does - Entitlement Management: Retrieve and query detailed entitlement information including purchased licenses, assigned licenses, entitlement types - Usage and Utilization: Access real-time usage statistics, track license usage - Entitlement Availability: Calculate available entitlement capacity, determine allocation availability based on current usage, and access banner notifications for entitlements requiring attention - Assignment Management: Create, retrieve, update, and delete entitlement assignments - Synchronization: Synchronize entitlement data from latest purchase - Query Operations: Retrieve entitlement and assignment data with pagination, sorting, and filtering capabilities - Compliance Monitoring: Monitor entitlement compliance status and identify licenses that exceed allocations or are underutilized Common Use Cases - Enterprise Entitlement Management: Track and manage entitlements across large organizations with multiple departments or business units - MSP/VAR Operations: Allocate and manage entitlements for customer accounts. - Usage Reporting: Generate periodic usage reports for capacity planning. - Compliance Auditing: Monitor entitlement usage to ensure compliance with subscription terms and conditions Technical Details - API Version: v0.2.0 - Content Types: Supports application/json and application/vnd.ruckus.v1+json for v1 endpoints - Regional Endpoints: Available in North America, Europe, and Asia Pacific regions Authentication & Authorization This API uses bearer token authentication with role based access control. Users must have appropriate permissions to perform operations on entitlements, assignments, and usage data. Version: v0.2.0 License: RUCKUS Cloud Privacy Policy ## Servers RUCKUS One API host for North American region. ``` https://api.ruckus.cloud ``` RUCKUS One API host for European region. ``` https://api.eu.ruckus.cloud ``` RUCKUS One API host for Asian region. ``` https://api.asia.ruckus.cloud ``` ## Download OpenAPI description [Entitlements](https://docs.ruckus.cloud/_bundle/api/entitlement-0.2.0.yaml) ## Entitlement Entitlement management and license operations. ### Get Entitlements Utilization Summaries - [POST /entitlements/utilizations/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/getsummary.md): Retrieve entitlement usage details. Usage summaries provide information on the number of entitlements used and active devices. ### Get Entitlements - [POST /entitlements/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/getentitlements.md): Retrieves all purchased entitlements for the authenticated tenant. Purchased entitlements represent the licenses, subscriptions, and service rights that an organization has acquired through purchases, contracts, or promotions. Each entitlement includes details about the license type, stock keeping unit (SKU), quantity, effective dates, expiration dates, device compatibility, and current usage status. What constitutes a purchased entitlement: subscription licenses with defined quantities and terms, promotional licenses granted for trials or special offers, perpetual licenses with unlimited duration, device specific licenses (access points, switches, analytics), and feature specific entitlements (security, guest access, location services). Available filters: filter by license type (subscription, trial, promotional), device type (wifi, switch, analytics, edge), license status (active, expired, pending), date ranges (effective date, expiration date), and SKU identifiers. Supports pagination, sorting, and field selection to customize the response. Response: returns a paginated list of entitlement objects with license details, quantities, dates, usage metrics, and associated device types. ### Query License Mileage Report - [POST /entitlements/mileageReports/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/licensemileagereports.md): Mileage reports offer clear insights into how licenses have been consumed and released across different periods. Request payload structure: accepts a mileage request object containing: - license type filters - pagination parameters (page size, page number) Available filters: - filter by specific license types - filter by date range (if applicable) - additional filters based on business requirements Response format: returns a mileage response containing a list of mileage report entries. each entry provides: - monthly usage data - breakdown of license increases and decreases - key metrics reflecting license life cycle changes. ### Get Compliance - [POST /entitlements/compliances/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/getcompliances.md): Retrieve detailed license availability reports that calculate how many licenses are currently available for assignment or consumption. This endpoint performs real-time calculations to determine remaining license capacity by analyzing purchased entitlements, active assignments, expired licenses, and reserved allocations. Availability reports are essential for capacity planning and preventing over allocation. ### Get Entitlements Banners - [POST /entitlements/banners/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/getbanners.md): Retrieve entitlement banner data for display in the user interface. Banners are visual notifications that alert administrators about critical license conditions requiring attention. They provide information about entitlements that are either near their expiry or have expired, helping prevent service disruptions. Version application/vnd.ruckus.v1+JSON will be removed no sooner than 08/31/2026. application/JSON and application/vnd.ruckus.v1.1+JSON are now available. ### Query Availability Reports - [POST /entitlements/availabilityReports/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/licenseavailabilityreports.md): This endpoint allows you to query availability reports for entitlements. ### Query License Attention Notes - [POST /entitlements/attentionNotes/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/queryattentionnote.md): Queries license attention notes, which are alerts and notifications related to license status that require administrator attention. Attention notes are automatically generated for important license events such as upcoming change in licensing system. ### Update Entitlements - [PATCH /entitlements](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/syncentitlements.md): Synchronizes entitlements by triggering a refresh of license data from external licensing systems. This operation fetches the latest license purchases, renewals, and modifications, then updates the local entitlement cache to reflect current entitlements. What is synchronized: new license purchases, license quantity changes, expiration date updates, license type modifications, subscription renewals. Prerequisites: the tenant must have an active entitlement ID and at least one active subscription. ### Get Entitlement Usage Report - [GET /entitlements/licenseUsageReports](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/getusagereport.md): Get the entitlement usage report. ## Manage Entitlements ### Get Tenant Entitlement Assignments - [POST /tenants/{tenantId}/entitlements/assignments/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/manage-entitlements/getentitlementassignments.md): Retrieves entitlement assignments allocated to a specific customer tenant by an MSP. Entitlement assignments represent the allocation of licenses from a provider's bulk license pool to individual MSP_EC tenants, enabling customers to use specific products and services based on the assigned license quantities and types. This endpoint allows providers to view which licenses have been assigned to a tenant, and monitor assignment details including quantities, expiration dates, and current status. Use cases: track license allocations to customer tenants, verify assignment status before making changes. ### Create a Self Assignment - [POST /tenants/self/entitlements/assignments](https://docs.ruckus.cloud/api/entitlement-0.2.0/manage-entitlements/createentitlementassignment.md): Creates a self assignment by allocating licenses from the MSP's bulk entitlement pool to their own tenant account. Self assignments allow MSPs to assign licenses to their own devices rather than to customer tenants. This is useful when the MSP needs to manage and license their own device separately from customer allocations. ### Get MSP Self Assignments - [POST /tenants/self/entitlements/assignments/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/manage-entitlements/getselfentitlementassignments.md): Retrieves self assignments, which are entitlement allocations where the tenant manages their own license distribution for internal use. An MSP uses self assignments to allocate licenses from their bulk license pool to their own tenant account, rather than assigning them to customer tenants. Self assignments represent licenses that the provider reserves for managing their own devices. This allows providers to separate their internal license consumption from customer allocations for better tracking and resource management. Use cases: track internally allocated resources separately from customer assignments. ### Delete Self Assignment - [DELETE /tenants/self/entitlements/assignments/{id}](https://docs.ruckus.cloud/api/entitlement-0.2.0/manage-entitlements/deleteentitlementassignment.md): Deletes an active self assignment by marking it as revoked. When a license is deleted, it is not physically removed from the system but instead marked as revoked and can no longer be used. The assignment record is preserved for audit purposes. Returns a 204 no content status code on successful deletion, or a 409 conflict if the assignment has already expired or been revoked. ### Update a Self Assignment - [PATCH /tenants/self/entitlements/assignments/{id}](https://docs.ruckus.cloud/api/entitlement-0.2.0/manage-entitlements/updateentitlementassignment.md): Updates an existing self assignment where the MSPs has allocated licenses to their own tenant account. Quantity and expiry date can be modified for self assignments. When updating assignments, existing assignments will be revoked and new assignments will be created with the updated fields. This allows MSPs to adjust the number of licenses allocated to their own infrastructure as their needs change.