Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Administration Guide

Create an API Interface

You can create an interface that only allows API access through HTTPS port.

Before you create the API interface, be aware that you cannot:

  • Set or unset API port with the GUI (CLI only)
  • Login to to the API port with the GUI (access will be denied)
  • View the api-port in Sniffer settings
  • Access the API port through HTTP
  • Set the api-port interface as an admin port or HA port
  • Set admin-port, port3, sniffer port, or HA port as an api-port
To display the API information with the CLI:

show

Example
IPv4 Default Gateway: 10.59.4.1                                                            Administration interface(s): port1 bond1                                           API interface(s): port2
To add an API port with the CLI:

set api-port port2

To unset an API port with the CLI:

unset api-port port2

To view an API interface in the GUI:
  1. Go to System > Interfaces.
  2. In the Interface column, the port is appended with API port.

Create an API Interface

You can create an interface that only allows API access through HTTPS port.

Before you create the API interface, be aware that you cannot:

  • Set or unset API port with the GUI (CLI only)
  • Login to to the API port with the GUI (access will be denied)
  • View the api-port in Sniffer settings
  • Access the API port through HTTP
  • Set the api-port interface as an admin port or HA port
  • Set admin-port, port3, sniffer port, or HA port as an api-port
To display the API information with the CLI:

show

Example
IPv4 Default Gateway: 10.59.4.1                                                            Administration interface(s): port1 bond1                                           API interface(s): port2
To add an API port with the CLI:

set api-port port2

To unset an API port with the CLI:

unset api-port port2

To view an API interface in the GUI:
  1. Go to System > Interfaces.
  2. In the Interface column, the port is appended with API port.