API Permissions Overview

API Permissions are based on WebAdmin permissions. You can run any Netsweeper API to perform any task you have permission to perform in the WebAdmin. For example, if you have permission to create Groups in the WebAdmin, you can use the group_create API call to perform that function.

In order to use the WebAdmin API Test Tool, you will need the System Tools > API Test permission, which is only available to admin Accounts. However, SysOps can run API calls in their web browser by entering the command in their browser URL bar.

Example:

The following example uses one API call to authenticate with a valid Access Token, and a second API call to run the 'group_list' API call.

Step 1.

https://servername/webadmin/api/token.php?token=VALUE

OK:

Step 2.

https://servername/webadmin/api/group_list.php?

OK:

groupname=>Allowlistonly

groupname=>Child

groupname=>default

groupname=>Generous

groupname=>Limited

groupname=>Parent

groupname=>support

groupname=>Unrestricted

If you have not authenticated either with an Access Token or a valid Account name and password, you will receive a 'permission denied' output.

https://servername/webadmin/api/group_list.php?

ERROR: Permission Denied: Unauthorized access.

Additional information on Access Tokens can be found in our My Account Preferences documentation and our Access Token Authentication document.