Skip to content
Overview/
/Entitlements/
Changed
Last updated

Entitlements

GET /banners
Parameters:
  • Changed: type in query

Filter by device type (Optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

Return Type:
  • Deleted response : 500 Internal Server Error

Internal Server Error

GET /assignments/summaries

Get Assignment Summaries

Return Type:
  • Deleted response : 400 Bad Request

Bad/malformed request

  • Deleted response : 401 Unauthorized

Unauthorized

  • Deleted response : 403 Forbidden

Forbidden

  • Deleted response : 404 Not Found

Requested resource or related-entity not found

  • Deleted response : 422 Unprocessable Entity

Validation error

  • Deleted response : 423 Locked

Locked

  • Deleted response : 500 Internal Server Error

Internal Server Error

  • Changed response : 200 OK

OK

GET /mspEntitlements

Retrieve MSP bulk license pools

Return Type:
  • Deleted response : 400 Bad Request

Bad/malformed request

  • Deleted response : 401 Unauthorized

Unauthorized

  • Deleted response : 403 Forbidden

Forbidden

  • Deleted response : 404 Not Found

Requested resource or related-entity not found

  • Deleted response : 422 Unprocessable Entity

Validation error

  • Deleted response : 423 Locked

Locked

  • Deleted response : 500 Internal Server Error

Internal Server Error

  • Changed response : 200 OK

OK

GET /mspEntitlements/summaries

Sync MSP entitlement summaries

Return Type:

New response : 202 Accepted

Accepted - refresh request submitted

  • Deleted response : 400 Bad Request

Bad/malformed request

  • Deleted response : 401 Unauthorized

Unauthorized

  • Deleted response : 403 Forbidden

Forbidden

  • Deleted response : 404 Not Found

Requested resource or related-entity not found

  • Deleted response : 422 Unprocessable Entity

Validation error

  • Deleted response : 423 Locked

Locked

  • Deleted response : 500 Internal Server Error

Internal Server Error

  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property mspEntitlementBanners (object)

      Collection of banner notifications generated based on the refreshed entitlement data. Contains alerts for expiring licenses, capacity warnings, and compliance issues requiring administrator attention. Banners are derived from analyzing the refreshed entitlements for conditions that need visibility.

    • Added property mspEntitlementSummaries (object)

      Collection of aggregated entitlement summaries grouped by license type and expiration characteristics. Provides summary statistics and remaining capacity calculations derived from the detailed entitlements. Used for dashboard displays and quick availability checks without processing individual entitlement records.

    • Added property mspEntitlements (object)

      List of detailed MSP entitlement records retrieved from the external license system. Each entitlement represents a license pool with complete details including SKU, quantity, dates, and device associations. This is the primary data refreshed during synchronization operations.

GET /entitlements/summaries
Parameters:
  • Changed: type in query

Filter by device type (optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

Return Type:
  • Deleted response : 500 Internal Server Error

Internal Server Error

  • Changed response : 404 Not Found

This tenant does not exist.

  • Changed content type : application/json

    • Added property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Added property message (object)

      Human-readable error message providing details about what went wrong.

    • Added property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Added property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 417 Expectation Failed

This tenant does not have Entitlement ID.

  • Changed content type : application/json

    • Added property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Added property message (object)

      Human-readable error message providing details about what went wrong.

    • Added property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Added property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 200 OK

Returns the entitlement summary. The response is actual in case when the refresh request parameter value is false

  • Changed content type : application/json

    • Changed property banners (object)

      Collection of license banner notifications containing alerts, warnings, and informational messages related to license status, expiration, and compliance.

    • Changed property entitlements (object)

      List of entitlement objects containing detailed license information including quantities, dates, SKUs, and device types.

    • Changed property summary (object)

      Collection of entitlement operation summaries providing aggregated license information, usage statistics, and compliance details.

  • Changed response : 202 Accepted

Returns Use activity link in the Location header to track the refresh status. The response is actual in case when the refresh request parameter value is true

  • Changed content type : application/json

    • Changed property desc (object)

      Human-readable description providing details about the accepted request, its purpose, and expected processing outcome.

    • Changed property link (object)

      URI link for tracking or retrieving the status of the accepted request.

    • Changed property requestId (object)

      Unique identifier assigned to track the accepted request throughout its processing life cycle, enabling status monitoring and correlation with logs.

GET /entitlements
Parameters:
  • Changed: type in query

Filter by device type (optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

Return Type:
  • Deleted response : 500 Internal Server Error

Internal Server Error

  • Changed response : 404 Not Found

This tenant does not exist.

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 417 Expectation Failed

Entitlement ID is missing.

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

PATCH /entitlements
Request:

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property refreshType (object)

    Type of refresh operation to perform during synchronization, determining the scope and method of the entitlement data refresh.

    Added enum value:

    • PAGINATED

  • Changed property usageType (object)

    Usage type for entitlement synchronization, specifying the context of the sync operation; deprecated and not used in V2.

Return Type:
  • Changed response : 202 Accepted

Sync entitlements

  • Changed content type : application/json

    • Changed property desc (object)

      Human-readable description providing details about the accepted request, its purpose, and expected processing outcome.

    • Changed property link (object)

      URI link for tracking or retrieving the status of the accepted request.

    • Changed property requestId (object)

      Unique identifier assigned to track the accepted request throughout its processing life cycle, enabling status monitoring and correlation with logs.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property desc (object)

      Human-readable description providing details about the accepted request, its purpose, and expected processing outcome.

    • Changed property link (object)

      URI link for tracking or retrieving the status of the accepted request.

    • Changed property requestId (object)

      Unique identifier assigned to track the accepted request throughout its processing life cycle, enabling status monitoring and correlation with logs.

  • Changed response : 404 Not Found

Tenant not found.

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 417 Expectation Failed

Entitlement ID is missing. At least one tenant subscription must be active.

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

POST /entitlements/attentionNotes/query
Request:
  • Changed content type : application/json
  • Changed property filters (object)

    Filter criteria for attention note queries, containing various filtering options including type, tenant type, status, enabled state, and license check requirements.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    Filter criteria for attention note queries, containing various filtering options including type, tenant type, status, enabled state, and license check requirements.

Return Type:
  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors that occurred during processing, if any.

    • Changed property fields (object)

      Set of field names that were requested to be included in the response data.

    • Changed property objectId (object)

      Unique identifier for the primary object or entity associated with this query response.

    • Changed property pageSize (object)

      Maximum number of records returned in this response page.

    • Changed property subsequentQueries (object)

      List of additional API calls that can be made to retrieve related or supplementary data.

    • Changed property totalCount (object)

      Total number of records available that match the query criteria, used for pagination calculations.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of errors that occurred during processing, if any.

    • Changed property fields (object)

      Set of field names that were requested to be included in the response data.

    • Changed property objectId (object)

      Unique identifier for the primary object or entity associated with this query response.

    • Changed property pageSize (object)

      Maximum number of records returned in this response page.

    • Changed property subsequentQueries (object)

      List of additional API calls that can be made to retrieve related or supplementary data.

    • Changed property totalCount (object)

      Total number of records available that match the query criteria, used for pagination calculations.

  • Changed response : 403 Forbidden

Access Denied

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

POST /entitlements/availabilityReports/query
Request:

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    Request object containing filter criteria for entitlement calculations including usage type and license type parameters.

    • Changed property isTrial (object)

      Indicates whether to calculate availability for trial/temporary licenses. When true, the calculation considers only trial license entitlements which are typically temporary evaluation licenses. When false, the calculation considers standard purchased licenses. This flag helps distinguish between trial and production license availability in the entitlement calculation.

    • Changed property licenseType (object)

      Type of entitlement license to calculate.

    • Changed property usageType (object)

      Type of usage. Possible values: SELF (default), ASSIGNED, UNKNOWN.

Return Type:
  • Changed response : 403 Forbidden

Access Denied

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property data (object)

      License availability calculation data containing detailed information about license quantities, types, effective dates, and trial status for entitlement availability calculations.

      New optional properties:

      • expirationDate

      • Added property skuTier (object)

        SKU tier level for the license.

      • Changed property isTrial (object)

        Indicates whether this calculation is for trial/temporary licenses. Trial licenses are temporary evaluation licenses that allow customers to test functionality before purchasing full licenses. When true, the calculation considers trial license availability; when false, it considers standard purchased license availability. This distinction affects which entitlements are included in the availability calculation.

      • Changed property licenseType (object)

        Type of license being calculated.

      • Changed property quantity (object)

        Total number of licenses available.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property data (object)

      License availability calculation data containing detailed information about license quantities, types, effective dates, and trial status for entitlement availability calculations.

      New optional properties:

      • expirationDate

      • Added property skuTier (object)

        SKU tier level for the license.

      • Changed property isTrial (object)

        Indicates whether this calculation is for trial/temporary licenses. Trial licenses are temporary evaluation licenses that allow customers to test functionality before purchasing full licenses. When true, the calculation considers trial license availability; when false, it considers standard purchased license availability. This distinction affects which entitlements are included in the availability calculation.

      • Changed property licenseType (object)

        Type of license being calculated.

      • Changed property quantity (object)

        Total number of licenses available.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

POST /entitlements/banners/query
Request:

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    Filter criteria used to determine which entitlement banners should be displayed based on license type and usage preferences.

    • Changed property licenseType (object)

      List of license types to filter entitlement banners for, determining which specific license categories should be included in banner notifications.

    • Changed property usageType (object)

      Usage type filter for banner display, specifying whether to show banners for self managed or assigned licenses; defaults to SELF and is deprecated in V2.

Return Type:
  • Changed response : 200 OK

success

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

This tenant does not exist.

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

POST /entitlements/compliances/query
Request:

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    Filter criteria for license compliance queries including license types and compliance status parameters.

    • Changed property complianceType (object)

      Compliance status type for filtering results by adherence level (deprecated in V2).

    • Changed property licenseType (object)

      Set of license type identifiers to filter compliance results by specific entitlement categories.

Return Type:
  • Changed response : 200 OK

success

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property compliances (object)

      List of license compliance details for each tenant, including license usage statistics, device compliance status, and license assignment information.

  • Changed response : 404 Not Found

This tenant does not exist.

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

GET /entitlements/licenseUsageReports
Parameters:
  • Changed: startDate in query

The first date included in the usage report, for example, startDate=2024-01-15; if omitted, the startDate is set to last month's first date.

  • Changed: endDate in query

The end date included in the usage report, for example, endDate=2024-01-31; if omitted, the endDate is set to last month's last date.

  • Changed: month in query

month=MM

  • Changed: year in query

year=YYYY

Return Type:
  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property dailyReport (object)

      Collection of daily usage reports providing daily breakdown of device assignments, customer activity, and operational metrics for detailed analysis.

    • Added property dailyReportPerPage (object)

      Number of daily reports included per page for pagination sizing and performance optimization.

    • Added property grandTotalAssignmentDays (object)

      Grand total of all device assignment days across all device types and customers for billing calculations.

    • Added property grandTotalDeviceDays (object)

      Grand total of all operational device days across all device types for capacity planning and utilization analysis.

    • Added property licenseType (object)

      Device license type enumeration specifying the category of devices covered in this usage report for billing classification.

      Enum values:

      • MSP_WIFI
      • MSP_WIFI_TEMP
      • MSP_ICX
      • MSP_ICX71L
      • MSP_ICX71
      • MSP_ICX75
      • MSP_ICX76
      • MSP_ICX78
      • MSP_ICX_ANY
      • MSP_EDGE
      • MSP_EDGE_TEMP
      • MSP_APSW
      • MSP_APSW_TEMP
      • MSP_URLF
      • MSP_EDGE_SECL
      • MSP_EDGE_SELS
      • MSP_SLTN_TOKEN
      • MSP_SLTN_TOKEN_TEMP

    • Added property mspName (object)

      Name of the managed service provider generating this usage report for identification and billing purposes.

    • Added property page (object)

      Current page number in the paginated result set, starting from 0 for pagination control.

    • Added property reportEndDate (object)

      Actual end date used in the generated report, which may differ from requested date due to data availability, using ISO date format (example: 2025-11-30).

    • Added property reportLicenseTypeName (object)

      Human-readable license type name used in report generation and CSV export for display purposes.

    • Added property reportStartDate (object)

      Actual start date used in the generated report, which may differ from requested date due to data availability, using ISO date format (example: 2025-11-01).

    • Added property requestEndDate (object)

      Original end date requested by the user for the usage report period, using ISO date format (example: 2025-11-30).

    • Added property requestStartDate (object)

      Original start date requested by the user for the usage report period, using ISO date format (example: 2025-11-21).

    • Added property totalAssignmentDaysByDevice (object)

      Detailed breakdown of assignment days grouped by device type and subtype for granular billing analysis and customer reporting.

    • Added property totalDaysInReport (object)

      Total number of days covered in this usage report, calculated from the actual report start and end dates.

    • Added property totalDeviceDaysByDevice (object)

      Detailed breakdown of operational device days grouped by device type and subtype for capacity planning and utilization tracking.

    • Added property totalPages (object)

      Total number of pages available in the complete result set for pagination navigation.

  • Changed content type : application/pdf

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property dailyReport (object)

      Collection of daily usage reports providing daily breakdown of device assignments, customer activity, and operational metrics for detailed analysis.

    • Added property dailyReportPerPage (object)

      Number of daily reports included per page for pagination sizing and performance optimization.

    • Added property grandTotalAssignmentDays (object)

      Grand total of all device assignment days across all device types and customers for billing calculations.

    • Added property grandTotalDeviceDays (object)

      Grand total of all operational device days across all device types for capacity planning and utilization analysis.

    • Added property licenseType (object)

      Device license type enumeration specifying the category of devices covered in this usage report for billing classification.

    • Added property mspName (object)

      Name of the managed service provider generating this usage report for identification and billing purposes.

    • Added property page (object)

      Current page number in the paginated result set, starting from 0 for pagination control.

    • Added property reportEndDate (object)

      Actual end date used in the generated report, which may differ from requested date due to data availability, using ISO date format (example: 2025-11-30).

    • Added property reportLicenseTypeName (object)

      Human-readable license type name used in report generation and CSV export for display purposes.

    • Added property reportStartDate (object)

      Actual start date used in the generated report, which may differ from requested date due to data availability, using ISO date format (example: 2025-11-01).

    • Added property requestEndDate (object)

      Original end date requested by the user for the usage report period, using ISO date format (example: 2025-11-30).

    • Added property requestStartDate (object)

      Original start date requested by the user for the usage report period, using ISO date format (example: 2025-11-21).

    • Added property totalAssignmentDaysByDevice (object)

      Detailed breakdown of assignment days grouped by device type and subtype for granular billing analysis and customer reporting.

    • Added property totalDaysInReport (object)

      Total number of days covered in this usage report, calculated from the actual report start and end dates.

    • Added property totalDeviceDaysByDevice (object)

      Detailed breakdown of operational device days grouped by device type and subtype for capacity planning and utilization tracking.

    • Added property totalPages (object)

      Total number of pages available in the complete result set for pagination navigation.

  • Changed content type : text/csv

  • Changed content type : text/json

  • Changed response : 404 Not Found

Tenant not found.

  • Changed content type : application/json

    • Deleted property cause (object)

    • Deleted property localizedMessage (object)

    • Deleted property stackTrace (object)

    • Deleted property suppressed (object)

    • Changed property eb (object)

      Error brief enumeration providing specific error categorization and associated error code for assignment operation failures.

      Added enum value:

      • ASSIGNMENT_NOT_CREATED

    • Changed property reason (object)

      Human readable reason or explanation for the assignment failure, derived from error codes or exception messages for user friendly error reporting.

    • Changed property ve (object)

      Validation error details containing information about failed input validation, including the object context, field names, values, and expected constraints for error reporting.

      • Changed property expected (object)

        Expected value, format, or constraint that the validation was checking against, helping users understand what input would be valid.

      • Changed property object (object)

        The object or entity type that failed validation, providing context about which data structure or model encountered the error.

      • Changed property objectName (object)

        Specific name or identifier of the object instance that failed validation, enabling precise error location identification.

  • Changed content type : application/pdf

    • Deleted property cause (object)

    • Deleted property localizedMessage (object)

    • Deleted property stackTrace (object)

    • Deleted property suppressed (object)

    • Changed property eb (object)

      Error brief enumeration providing specific error categorization and associated error code for assignment operation failures.

      Added enum value:

      • ASSIGNMENT_NOT_CREATED

    • Changed property reason (object)

      Human readable reason or explanation for the assignment failure, derived from error codes or exception messages for user friendly error reporting.

    • Changed property ve (object)

      Validation error details containing information about failed input validation, including the object context, field names, values, and expected constraints for error reporting.

      • Changed property expected (object)

        Expected value, format, or constraint that the validation was checking against, helping users understand what input would be valid.

      • Changed property object (object)

        The object or entity type that failed validation, providing context about which data structure or model encountered the error.

      • Changed property objectName (object)

        Specific name or identifier of the object instance that failed validation, enabling precise error location identification.

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property cause (object)

    • Deleted property localizedMessage (object)

    • Deleted property stackTrace (object)

    • Deleted property suppressed (object)

    • Changed property eb (object)

      Error brief enumeration providing specific error categorization and associated error code for assignment operation failures.

      Added enum value:

      • ASSIGNMENT_NOT_CREATED

    • Changed property reason (object)

      Human readable reason or explanation for the assignment failure, derived from error codes or exception messages for user friendly error reporting.

    • Changed property ve (object)

      Validation error details containing information about failed input validation, including the object context, field names, values, and expected constraints for error reporting.

      • Changed property expected (object)

        Expected value, format, or constraint that the validation was checking against, helping users understand what input would be valid.

      • Changed property object (object)

        The object or entity type that failed validation, providing context about which data structure or model encountered the error.

      • Changed property objectName (object)

        Specific name or identifier of the object instance that failed validation, enabling precise error location identification.

  • Changed content type : text/csv

    • Deleted property cause (object)

    • Deleted property localizedMessage (object)

    • Deleted property stackTrace (object)

    • Deleted property suppressed (object)

    • Changed property eb (object)

      Error brief enumeration providing specific error categorization and associated error code for assignment operation failures.

      Added enum value:

      • ASSIGNMENT_NOT_CREATED

    • Changed property reason (object)

      Human readable reason or explanation for the assignment failure, derived from error codes or exception messages for user friendly error reporting.

    • Changed property ve (object)

      Validation error details containing information about failed input validation, including the object context, field names, values, and expected constraints for error reporting.

      • Changed property expected (object)

        Expected value, format, or constraint that the validation was checking against, helping users understand what input would be valid.

      • Changed property object (object)

        The object or entity type that failed validation, providing context about which data structure or model encountered the error.

      • Changed property objectName (object)

        Specific name or identifier of the object instance that failed validation, enabling precise error location identification.

  • Changed content type : text/json

    • Deleted property cause (object)

    • Deleted property localizedMessage (object)

    • Deleted property stackTrace (object)

    • Deleted property suppressed (object)

    • Changed property eb (object)

      Error brief enumeration providing specific error categorization and associated error code for assignment operation failures.

      Added enum value:

      • ASSIGNMENT_NOT_CREATED

    • Changed property reason (object)

      Human readable reason or explanation for the assignment failure, derived from error codes or exception messages for user friendly error reporting.

    • Changed property ve (object)

      Validation error details containing information about failed input validation, including the object context, field names, values, and expected constraints for error reporting.

      • Changed property expected (object)

        Expected value, format, or constraint that the validation was checking against, helping users understand what input would be valid.

      • Changed property object (object)

        The object or entity type that failed validation, providing context about which data structure or model encountered the error.

      • Changed property objectName (object)

        Specific name or identifier of the object instance that failed validation, enabling precise error location identification.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

POST /entitlements/mileageReports/query
Request:
  • Changed content type : application/json

  • Changed property filters (object)

    Request object containing filter criteria for entitlement calculations including usage type and license type parameters.

    • Changed property isTrial (object)

      Indicates whether to calculate availability for trial/temporary licenses. When true, the calculation considers only trial license entitlements which are typically temporary evaluation licenses. When false, the calculation considers standard purchased licenses. This flag helps distinguish between trial and production license availability in the entitlement calculation.

    • Changed property licenseType (object)

      Type of entitlement license to calculate.

    • Changed property usageType (object)

      Type of usage. Possible values: SELF (default), ASSIGNED, UNKNOWN.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    Request object containing filter criteria for entitlement calculations including usage type and license type parameters.

    • Changed property isTrial (object)

      Indicates whether to calculate availability for trial/temporary licenses. When true, the calculation considers only trial license entitlements which are typically temporary evaluation licenses. When false, the calculation considers standard purchased licenses. This flag helps distinguish between trial and production license availability in the entitlement calculation.

    • Changed property licenseType (object)

      Type of entitlement license to calculate.

    • Changed property usageType (object)

      Type of usage. Possible values: SELF (default), ASSIGNED, UNKNOWN.

Return Type:
  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property page (object)

      Current page number in the paginated result set.

    • Changed property pageSize (object)

      Number of records returned per page for pagination control.

    • Changed property totalCount (object)

      Total number of records available across all pages.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property page (object)

      Current page number in the paginated result set.

    • Changed property pageSize (object)

      Number of records returned per page for pagination control.

    • Changed property totalCount (object)

      Total number of records available across all pages.

  • Changed response : 403 Forbidden

Access Denied

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

POST /entitlements/query
Request:

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property defaultPageSize (object)

    Default number of records per page to use when pageSize is not explicitly specified or is invalid.

  • Changed property fields (object)

    Set of specific field names to include in the query response, enabling selective data retrieval.

  • Changed property pageSize (object)

    Number of records to return per page for pagination, with automatic fallback to default if invalid.

  • Changed property sortField (object)

    Field name to use for sorting the query results in ascending or descending order.

  • Changed property sortOrder (object)

    Sort order direction for the specified sort field, typically 'ASC' for ascending or 'DESC' for descending.

  • Changed property filters (object)

    Filter criteria for dynamic queries including field selections, value filters, and query parameters.

    • Added property expirationDateRange (object)

      Date range criteria for filtering entitlements based on expiration dates, supporting both past expired and future expiring time frames.

      • Property lastExpiredDays (object)

        The last number of days in which entitlements have expired.

      • Property nextExpiringDays (object)

        The next number of days in which entitlements will expire.

    • Added property renewable (object)

      Flag indicating if only fetching ACX licenses which pass external system validation for renewal purpose.

    • Added property sku (object)

      A list of SKU patterns in regular expression.

    • Added property skuTier (object)

      A list of SKU tiers.

    • Changed property usageType (object)

      Usage type. Deprecated (not used in V2). Possible values: SELF (default), ASSIGNED, UNKNOWN.

      Added enum values:

      • SELF
      • ASSIGNED
      • UNKNOWN
Return Type:
  • Changed response : 200 OK

success.

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors that occurred during processing, if any.

    • Changed property fields (object)

      Set of field names that were requested to be included in the response data.

    • Changed property objectId (object)

      Unique identifier for the primary object or entity associated with this query response.

    • Changed property pageSize (object)

      Maximum number of records returned in this response page.

    • Changed property subsequentQueries (object)

      List of additional API calls that can be made to retrieve related or supplementary data.

    • Changed property totalCount (object)

      Total number of records available that match the query criteria, used for pagination calculations.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of errors that occurred during processing, if any.

    • Changed property fields (object)

      Set of field names that were requested to be included in the response data.

    • Changed property objectId (object)

      Unique identifier for the primary object or entity associated with this query response.

    • Changed property pageSize (object)

      Maximum number of records returned in this response page.

    • Changed property subsequentQueries (object)

      List of additional API calls that can be made to retrieve related or supplementary data.

    • Changed property totalCount (object)

      Total number of records available that match the query criteria, used for pagination calculations.

  • Changed response : 404 Not Found

Tenant not found.

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 417 Expectation Failed

Cannot display subscription data: entitlement ID is missing. At least one tenant subscription must be active.

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/vnd.ruckus.v1.1+json

  • Deleted content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

POST /entitlements/utilizations/query
Request:

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    Filter criteria for dynamic queries including field selections, value filters, and query parameters.

    • Added property expirationDateRange (object)

      Date range criteria for filtering entitlements based on expiration dates, supporting both past expired and future expiring time frames.

    • Added property renewable (object)

      Flag indicating if only fetching ACX licenses which pass external system validation for renewal purpose.

    • Added property sku (object)

      A list of SKU patterns in regular expression.

    • Added property skuTier (object)

      A list of SKU tiers.

    • Changed property usageType (object)

      Usage type. Deprecated (not used in V2). Possible values: SELF (default), ASSIGNED, UNKNOWN.

      Added enum values:

      • SELF
      • ASSIGNED
      • UNKNOWN
  • Changed content type : application/vnd.ruckus.v1.1+json

  • Changed property filters (object)

    Filter criteria for dynamic queries including field selections, value filters, and query parameters.

    • Added property expirationDateRange (object)

      Date range criteria for filtering entitlements based on expiration dates, supporting both past expired and future expiring time frames.

    • Added property renewable (object)

      Flag indicating if only fetching ACX licenses which pass external system validation for renewal purpose.

    • Added property sku (object)

      A list of SKU patterns in regular expression.

    • Added property skuTier (object)

      A list of SKU tiers.

    • Changed property usageType (object)

      Usage type. Deprecated (not used in V2). Possible values: SELF (default), ASSIGNED, UNKNOWN.

      Added enum values:

      • SELF
      • ASSIGNED
      • UNKNOWN
Return Type:
  • Changed response : 200 OK

Returns entitlement utilization query response for SELF usage type or assigned entitlement summaries response for ASSIGNED usage type.

  • Changed content type : application/json

    • Added property data (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property data (object)

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Added property data (object)
  • Changed response : 404 Not Found

Tenant not found.

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 417 Expectation Failed

Cannot display subscription data: entitlement ID is missing. At least one tenant subscription must be active.

  • Changed content type : application/json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Changed property code (object)

      Unique error code identifying the specific type of error that occurred.

    • Changed property message (object)

      Human-readable error message providing details about what went wrong.

    • Changed property reason (object)

      Detailed explanation of why the error occurred, providing additional context.

    • Changed property suggestion (object)

      Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

POST /tenants/self/entitlements/assignments
Request:
  • Changed content type : application/json

  • Changed property licenseType (object)

    Type of entitlement license being assigned.

  • Changed property trial (object)

    Flag indicating whether this assignment is for a trial period with limited duration and features.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property licenseType (object)

    Type of entitlement license being assigned.

  • Changed property trial (object)

    Flag indicating whether this assignment is for a trial period with limited duration and features.

Return Type:
  • Changed response : 201 Created

Created a self assignment

  • Changed content type : application/json

    • Changed property data (object)

      License assignment containing details about assigned entitlements including dates, quantities, and status information.

      • Changed property isTrial (object)

        Indicates whether this assignment is using a trial/temporary license. Trial licenses are typically temporary evaluation licenses that allow customers to test functionality before purchasing full licenses. When true, the assignment uses a temporary entitlement; when false, it uses a standard purchased license.

      • Changed property licenseType (object)

        Type of entitlement license assigned.

      • Changed property revokedBy (object)

        User who revoked the assignment.

      • Changed property revokedDate (object)

        Date when the assignment was revoked.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property data (object)

      License assignment containing details about assigned entitlements including dates, quantities, and status information.

      • Changed property isTrial (object)

        Indicates whether this assignment is using a trial/temporary license. Trial licenses are typically temporary evaluation licenses that allow customers to test functionality before purchasing full licenses. When true, the assignment uses a temporary entitlement; when false, it uses a standard purchased license.

      • Changed property licenseType (object)

        Type of entitlement license assigned.

      • Changed property revokedBy (object)

        User who revoked the assignment.

      • Changed property revokedDate (object)

        Date when the assignment was revoked.

  • Changed response : 400 Bad Request

Bad input, such as missing required fields.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal server error.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

POST /tenants/self/entitlements/assignments/query

Get MSP Self Assignments

Request:
  • Changed content type : application/json
  • Changed property filters (object)

    Filter criteria for querying license assignments. Allows filtering by license type, assignment status, creator, and trial status.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    Filter criteria for querying license assignments. Allows filtering by license type, assignment status, creator, and trial status.

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors that occurred during processing, if any.

    • Changed property fields (object)

      Set of field names that were requested to be included in the response data.

    • Changed property objectId (object)

      Unique identifier for the primary object or entity associated with this query response.

    • Changed property pageSize (object)

      Maximum number of records returned in this response page.

    • Changed property subsequentQueries (object)

      List of additional API calls that can be made to retrieve related or supplementary data.

    • Changed property totalCount (object)

      Total number of records available that match the query criteria, used for pagination calculations.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of errors that occurred during processing, if any.

    • Changed property fields (object)

      Set of field names that were requested to be included in the response data.

    • Changed property objectId (object)

      Unique identifier for the primary object or entity associated with this query response.

    • Changed property pageSize (object)

      Maximum number of records returned in this response page.

    • Changed property subsequentQueries (object)

      List of additional API calls that can be made to retrieve related or supplementary data.

    • Changed property totalCount (object)

      Total number of records available that match the query criteria, used for pagination calculations.

  • Changed response : 400 Bad Request

Bad input, missing tenant ID.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal server error.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

DELETE /tenants/self/entitlements/assignments/{id}
Return Type:
  • Changed response : 400 Bad Request

Bad input, such as missing required fields.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 409 Conflict

If the assignment already have been revoked.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal server error.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

PATCH /tenants/self/entitlements/assignments/{id}
Request:
  • Changed content type : application/json
  • Changed property valid (object)

    Indicates whether the assignment request contains valid data with at least one non null field (expirationDate or quantity).

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property valid (object)

    Indicates whether the assignment request contains valid data with at least one non null field (expirationDate or quantity).

Return Type:
  • Changed response : 200 OK

Assignment updated successfully

  • Changed content type : application/json

    • Changed property data (object)

      License assignment containing details about assigned entitlements including dates, quantities, and status information.

      • Changed property isTrial (object)

        Indicates whether this assignment is using a trial/temporary license. Trial licenses are typically temporary evaluation licenses that allow customers to test functionality before purchasing full licenses. When true, the assignment uses a temporary entitlement; when false, it uses a standard purchased license.

      • Changed property licenseType (object)

        Type of entitlement license assigned.

      • Changed property revokedBy (object)

        User who revoked the assignment.

      • Changed property revokedDate (object)

        Date when the assignment was revoked.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property data (object)

      License assignment containing details about assigned entitlements including dates, quantities, and status information.

      • Changed property isTrial (object)

        Indicates whether this assignment is using a trial/temporary license. Trial licenses are typically temporary evaluation licenses that allow customers to test functionality before purchasing full licenses. When true, the assignment uses a temporary entitlement; when false, it uses a standard purchased license.

      • Changed property licenseType (object)

        Type of entitlement license assigned.

      • Changed property revokedBy (object)

        User who revoked the assignment.

      • Changed property revokedDate (object)

        Date when the assignment was revoked.

  • Changed response : 400 Bad Request

Bad input, such as missing required fields.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 402 Payment Required

Insufficient license

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 409 Conflict

If the assignment has already expired.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal server error.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

POST /tenants/{tenantId}/entitlements/assignments/query

Get Tenant Entitlement Assignments

Request:
  • Changed content type : application/json
  • Changed property filters (object)

    Filter criteria for querying license assignments. Allows filtering by license type, assignment status, creator, and trial status.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    Filter criteria for querying license assignments. Allows filtering by license type, assignment status, creator, and trial status.

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors that occurred during processing, if any.

    • Changed property fields (object)

      Set of field names that were requested to be included in the response data.

    • Changed property objectId (object)

      Unique identifier for the primary object or entity associated with this query response.

    • Changed property pageSize (object)

      Maximum number of records returned in this response page.

    • Changed property subsequentQueries (object)

      List of additional API calls that can be made to retrieve related or supplementary data.

    • Changed property totalCount (object)

      Total number of records available that match the query criteria, used for pagination calculations.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of errors that occurred during processing, if any.

    • Changed property fields (object)

      Set of field names that were requested to be included in the response data.

    • Changed property objectId (object)

      Unique identifier for the primary object or entity associated with this query response.

    • Changed property pageSize (object)

      Maximum number of records returned in this response page.

    • Changed property subsequentQueries (object)

      List of additional API calls that can be made to retrieve related or supplementary data.

    • Changed property totalCount (object)

      Total number of records available that match the query criteria, used for pagination calculations.

  • Changed response : 400 Bad Request

Bad input, missing tenant ID.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed response : 500 Internal Server Error

Internal server error.

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property requestId (object)

      Unique identifier for the request that generated this error, used for tracking and debugging purposes.

    • Changed property error (object)

      Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

      • Changed property code (object)

        Unique error code identifying the specific type of error that occurred.

      • Changed property message (object)

        Human-readable error message providing details about what went wrong.

      • Changed property reason (object)

        Detailed explanation of why the error occurred, providing additional context.

      • Changed property suggestion (object)

        Actionable suggestion or recommendation for how to resolve or avoid this error.

DELETE /assignments

Revoke Bulk Assignments

Request:
  • Changed content type : application/json
Return Type:
  • Deleted response : 400 Bad Request

Bad/malformed request

  • Deleted response : 401 Unauthorized

Unauthorized

  • Deleted response : 403 Forbidden

Forbidden

  • Deleted response : 404 Not Found

Requested resource or related-entity not found

  • Deleted response : 422 Unprocessable Entity

Validation error

  • Deleted response : 423 Locked

Locked

  • Deleted response : 500 Internal Server Error

Internal Server Error

  • Changed response : 204 No Content

No Content

  • Changed content type : application/json

    • Changed property assignments (object)

      Collection of license assignments associated with the operation.

    • Changed property errorBrief (object)

      Brief error classification providing quick error identification.

      Added enum value:

      • ASSIGNMENT_NOT_CREATED

    • Changed property errorMessage (object)

      Detailed error message describing the cause of the operation failure.

    • Changed property ve (object)

      Validation error details containing information about failed input validation, including the object context, field names, values, and expected constraints for error reporting.

      • Changed property expected (object)

        Expected value, format, or constraint that the validation was checking against, helping users understand what input would be valid.

      • Changed property object (object)

        The object or entity type that failed validation, providing context about which data structure or model encountered the error.

      • Changed property objectName (object)

        Specific name or identifier of the object instance that failed validation, enabling precise error location identification.

Previous page
Next page