Chapter 11: Remote Access API
This chapter describes the web based API features that are available on the DHCPatriot
system and how they may be used. These features are useful for integrating into
automated scripts to perform some task. They consist of sending a specific GET via
secure web (HTTPS) on port 443. Each of these features requires that an administrator
be setup with appropriate admin level and CLI user access.
Setting up the User for API Access
A special user must be
configured to access the API.
This user will not be able to
access the Web
Administrations Interface.
Similarly, existing Web
Administration Interface users
will not be able to access the
API.
To setup this user, connect to
the Web Administration
Interface. Click on System
Configuration. Click on
Administrators. You should get
a screen similar to figure 11.1.
Fill out the name, username
and password, or use
encrypted password if you have a pre-encrypted
password to be used. The encrypted password must
be an MD5 encrypted password, if used. Admin
level should be set to level six. Of particular
importance is item number six, API User as shown in
figure 11.2. This field must be checked for an API
user. Checking this field makes the Web Administration Interface unavailable to the
user. The user admin restriction fields are not needed as the restrictions are not applied
to the API User whom is admin level six.
User Access
This set of functions is useful only to the Authenticated DHCP. They consist of
authenticating, suspending and enabling user devices. Standard DHCP contains no
such designation and so these do not apply.
Chapter 11: Remote Access API
75
DHCPatriot Version 6 Operations Manual This document © 2017 First Network Group Inc. All Rights Reserved
Figure 11.1
Figure 11.2
Содержание DHCPatriot Version 6
Страница 1: ...Operations Manual Version 6...
Страница 2: ......