Netsweeper 8.1 WebAdmin APIs

WebAdmin Web APIs Overview

This document is an overview of the Netsweeper WebAdmin Web APIs. 

About the WebAdmin Web APIs

The WebAdmin APIs allows customers to integrate with the Netsweeper database via a simple to use Web API.  There are two specific versions of the API that are available:

  • Direct URL

  • SOAP API

Both APIs contain very similar functionality.  Moving forward Netsweeper will be focusing on the SOAP API specification however, the Direct URL specification will also remain for legacy integrations.  As we add more API functions and features, they will be introduced to both formats and possibly new formats.

PDF Document

Download:

8.1 PDF Document

What's New in Netsweeper WebAdmin 8.1 APIs

New APIs

account_preference_query

This exports the user's My Account > Preferences > Settings.

account_password_forcechange

This forces a password change for the selected Account.

account_password_unlock

This unlocks the password for the selected Account.

account_lockout_reset

This resets a locked out Account.

Updates

  • The password for account_create is now optional to accomodate the radius parser.

  • The group_list API now displays Simple Groups if the 'Simple Group Manager' permission is enabled and it displays Groups if the 'OnGuard' permission is enabled.

  • The account_query API now allows any SysOp to query themselves and login is no longer required. An empty login uses the Account making the request.

  • The account_perms_list API now allows any type of Account to query their own permissions.

Online Parameter

A new Online parameter has been added:

"This is set to false by default. If online is false, the call gets data cached in the database. When it is set to 1, it gets the real time state."

It has been added to these APIs:

systemstatus_get_cns_status

systemstatus_get_webdb_status

systemstatus_server_query

systemstatus_server_query_lists

 

 

p

All rights reserved.

Every effort has been made to ensure the accuracy of this document. However, Netsweeper Inc. makes no warranties with respect to this documentation and disclaims any implied warranties of merchantability and fitness for a particular purpose.  Netsweeper Inc. shall not be liable for any error or for incidental or consequential damages in connection with the furnishing, performance, or use of this document or the examples herein. The information in this documentation is subject to change without notice. Netsweeper and Netsweeper Inc. are trademarks or registered trademarks of Netsweeper Incorporated in Canada and/or in other countries. Other product names mentioned in this document may be trademarks or registered trademarks of their respective companies and are the sole property of their respective manufacturers.