Find Technical Content
  • Home
  • Ruckus Support Portal
  • Ruckus Networks
  • Table of Contents
  • Dark Mode

Powered by Titania Delivery

⚠ This cached page may be outdated. Click refresh to get the latest content.
Cached Version You are Offline

You are viewing a cached version of this page.

You are currently offline. This page was loaded from cache.

Cloudpath Enrollment System Legacy API User Guide, 5.8 800-72856-001 Rev A

  • 2 Ruckus Back Cover
  • 3 How to Use The Cloudpath API
    • 3.1 Overview
    • 3.2 Outbound: Sending Notifications to External Systems
      • 3.2.1 Format for Variables
    • 3.3 Inbound: Querying Cloudpath
      • 3.3.1 Creating an API Key
  • 4 API Examples
    • 4.1 Enrollment Queries and Actions
      • 4.1.1 Retrieve Enrollment Data
      • 4.1.2 Revoke/Unrevoke Enrollment
    • 4.2 Certificate Queries
      • 4.2.1 Generate Certificate
      • 4.2.2 Generate a P12 Certificate
      • 4.2.3 Revoke/Unrevoke Certificate
      • 4.2.4 Return Certificate Data
      • 4.2.5 Revoke Certificate by Certificate Serial Number
    • 4.3 User Queries
      • 4.3.1 Blocking/Unblocking User
      • 4.3.2 Revoke Enrollments
    • 4.4 Device Queries
      • 4.4.1 Block/Unblock Device
      • 4.4.2 Revoke Certificates
      • 4.4.3 Register MAC address
    • 4.5 Device Configuration Queries and Actions
      • 4.5.1 Generate Mobileconfig File
    • 4.6 External Queries
      • 4.6.1 Device Capabilities Query
      • 4.6.2 Device Authorization
      • 4.6.3 Change MAC Address
      • 4.6.4 Get Device Information by Certificate Serial Number
      • 4.6.5 Get Devices Associated with a Customer Account Number
      • 4.6.6 Get Device Information by MAC Address and Customer Account Number
      • 4.6.7 Revoke Certificate by MAC Address and Customer Account Number
      • 4.6.8 Clear Device Capability Cache (For Testing Only)
      • 4.6.9 Destroy Enrollment Records by Customer Account Number (For Testing Only)
      • 4.6.10 Destroy Enrollment Records by GUID
    • 4.7 External DPSK (eDPSK) Actions and Queries
    • 4.8 Modifying Settings in Cloudpath
      • 4.8.1 Return Passphrase Information
      • 4.8.2 Return Passphrase String
      • 4.8.3 Change Passphrase
      • 4.8.4 Create Voucher Object
    • 4.9 Troubleshooting

Copyright Statement

Copyright, Trademark and Proprietary Rights Information

© 2021 CommScope, Inc. All rights reserved.

No part of this content may be reproduced in any form or by any means or used to make any derivative work (such as translation, transformation, or adaptation) without written permission from CommScope, Inc. and/or its affiliates ("CommScope"). CommScope reserves the right to revise or change this content from time to time without obligation on the part of CommScope to provide notification of such revision or change.

Export Restrictions

These products and associated technical data (in print or electronic form) may be subject to export control laws of the United States of America. It is your responsibility to determine the applicable regulations and to comply with them. The following notice is applicable for all products or technology subject to export control:

   These items are controlled by the U.S. Government and authorized for export only to the country of ultimate destination for use by the ultimate consignee or end-user(s) herein identified. They may not be resold, transferred, or otherwise disposed of, to any other country or to any person other than the authorized ultimate consignee or end-user(s), either in their original form or after being incorporated into other items, without first obtaining approval from the U.S. government or as otherwise authorized by U.S. law and regulations.  

Disclaimer

THIS CONTENT AND ASSOCIATED PRODUCTS OR SERVICES ("MATERIALS"), ARE PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED. TO THE FULLEST EXTENT PERMISSIBLE PURSUANT TO APPLICABLE LAW, COMMSCOPE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, TITLE, NON-INFRINGEMENT, FREEDOM FROM COMPUTER VIRUS, AND WARRANTIES ARISING FROM COURSE OF DEALING OR COURSE OF PERFORMANCE. CommScope does not represent or warrant that the functions described or contained in the Materials will be uninterrupted or error-free, that defects will be corrected, or are free of viruses or other harmful components. CommScope does not make any warranties or representations regarding the use of the Materials in terms of their completeness, correctness, accuracy, adequacy, usefulness, timeliness, reliability or otherwise. As a condition of your use of the Materials, you warrant to CommScope that you will not make use thereof for any purpose that is unlawful or prohibited by their associated terms of use.

Limitation of Liability

IN NO EVENT SHALL COMMSCOPE, COMMSCOPE AFFILIATES, OR THEIR OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, SUPPLIERS, LICENSORS AND THIRD PARTY PARTNERS, BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER, EVEN IF COMMSCOPE HAS BEEN PREVIOUSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, WHETHER IN AN ACTION UNDER CONTRACT, TORT, OR ANY OTHER THEORY ARISING FROM YOUR ACCESS TO, OR USE OF, THE MATERIALS. Because some jurisdictions do not allow limitations on how long an implied warranty lasts, or the exclusion or limitation of liability for consequential or incidental damages, some of the above limitations may not apply to you.

Trademarks

ARRIS, the ARRIS logo, COMMSCOPE, RUCKUS, RUCKUS WIRELESS, the Ruckus logo, the Big Dog design, BEAMFLEX, CHANNELFLY, FASTIRON, ICX, SMARTCELL and UNLEASHED are trademarks of CommScope, Inc. and/or its affiliates. Wi-Fi Alliance, Wi-Fi, the Wi-Fi logo, Wi-Fi Certified, the Wi-Fi CERTIFIED logo, Wi-Fi Protected Access, the Wi-Fi Protected Setup logo, Wi-Fi Protected Setup, Wi-Fi Multimedia and WPA2 and WMM are trademarks or registered trademarks of Wi-Fi Alliance. All other trademarks are the property of their respective owners.

Did you find what you were looking for?

Thanks!

Ruckus Wireless

© 2026 Ruckus Wireless LLC All rights reserved.

  • Accessibility
  • Privacy & Cookies
  • Do Not Sell My Information
  • Trademarks
  • Terms
  • Feedback