✨ New: Try our AI‑powered Search (Ctrl + K) — Read more

REST API Requirements

Prev Next

To use the API and view the API documentation, you need the following:

  1. Sensor Management appliance
    • If a Sensor Management appliance is available for development purposes, you will need its IP address and a user account. Default administrator account: admin, 2admin$admin
  2. Sensor Management user account with multiple roles
  3. A Sensor Management user can have multiple roles. To access the Sensor Management web interface and use the API, you need a user account with at least two roles.
    • ROLE_WS: Has permission to use Web Services (WS). This is the role required to use the REST API in your client applications. At least one other role is also required.
    • ROLE_Admin: Has permission to access all Sensor Management functionality (other than Web Services, the REST API, and the XML/https Export Interface). You need this role if you want to use all possible functionality in the Sensor Management web interface.
    • Other roles: Your client application may not need full administrator permissions. You may want to create an account with the ROLE_WS and another role that has more limited permissions. For more information about user roles, see "Managing User Accounts".

© 2026 Cisco and/or its affiliates. All rights reserved.

For more information about trademarks, please visit:
Cisco trademarks 
For more information about legal terms, please visit:
Cisco legal terms