WebAdmin Web APIs Overview

This document is an overview of the Netsweeper WebAdmin Web APIs.  For specifications, please see:

·       Configuration - WebAdmin Web APIs

·       Configuration - Reporter 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.

What's New in Netsweeper WebAdmin 7.2 APIs

Here is a list of APIs added or updated in the 7.2 Netsweeper release.

list_entry_add_bulk

This adds multiple URLs and keywords to an existing List.

list_entry_delete_bulk

This deletes multiple URL and Keyword IDs from all Lists.

webadminstatus

This checks if the WebAdmin is working properly allowing user login. This can be used in Active-Active deployments to check if the WebAdmin is available for a load balancer.

Updates

listmanager_add_list

The listmanager_add_list API has a new ignorefail argument that does not stop the list import due to duplicate entries. If ignore_fail is set, it will not stop and display an error if a failure occurs. All errors will be displayed at the end instead.

A new 'Comment' argument has been added. This can be a separator delimited list of comments or a single comment for all entries.

client_add and client_modify

client_add and client_modify API arguments now include firstname, lastname, email, comments, and workstation.