Setup API User

Owned by Jonathan Tew
Last updated: Feb 10, 2022 by Hunter Schaeffer

Setup API User

In order to perform API calls to the system you must setup an user that will make the API calls and then authenticate their API address. First you configure the user under:

Main Menu → Configuration → Users → New User

First configure the basic information about the user and the password as shown below.

Next select the API permission, click the IP Addresses link, and then specify the IP address of the server that is going to be making the API calls.

  • An easy way to determine your server's public IP is to load up the site ipchicken.com with a text browser like links on the server
  • The API Access "IP Addresses" field can hold up to 15 IP addresses
  • The asterisk character "*" can be used as a wildcard in the API Access "IP Addresses" field

Related Documentation

API Simple Key (Configuring API User for REST Applications)