The interfaces to configure and operate ASE consist of:

  • Command line interface (CLI)
ASE interfaces


Located in the bin directory, is the script that administers ASE and performs all ASE functions except starting and stopping ASE. To execute commands, type followed by the command name. To see a list of all commands, type the following command at the CLI:


The following table lists some basic CLI commands. For a complete list, see CLI for inline ASE and CLI for sideband ASE.

Option Description

Displays help


Displays ASE’s version number

status Displays ASE’s status.
update_password Updates the password for ASE admin account.

After initial start-up, all configuration changes must be made using or ASE REST APIs. This includes adding a server, deleting a server, adding a new API, and so on. After manually editing an operational JSON file, follow Defining an API using API JSON configuration file in inline mode.

CLI commands include the following:

help command

To get a list of CLI commands, enter the help command:

/opt/pingidentity/ase/bin/ help

version command

To query system information, enter the version command:
/opt/pingidentity/ase/bin/ version
Ping Identity Inc., ASE 3.1.1
Kernel Version : 3.10
Operating System : Red Hat Enterprise Linux Server release 7.0 (Maipo)
Build Date : Fri Aug 24 13:43:22 UTC 2018

status command

To get ASE status, enter the status command:

/opt/pingidentity/ase/bin/ status
Ping Identity Inc., API Security Enforcer
status : started
http/ws : port 80
https/wss : port 443
firewall : enabled
abs : disabled, ssl: enabled
abs attack : disabled
audit : enabled
ase detected attack : disabled
attack list memory : configured 128.00 MB, used 25.60 MB, free 102.40 MB


The ASE REST API is used to administer ASE or integrate ASE with third-party products. Using the ASE REST API, you can configure ASE and display ASE statistics, including the number of backend servers, the number of APIs, and so on.

ASE REST API commands consist of the following:

  • API: Create API (POST), Read API (GET), List API (GET), Update API (PUT), Delete API (DELETE)
  • Server: Create Server (POST), Read Server (GET), Delete Server (DELETE)
  • Session: Read Persistent Connections (GET)
  • Cluster: Read Cluster (GET)
  • Firewall: Read Firewall Status (GET), Update Firewall Status (POST)
  • Flow Control: Read flow control (GET), Update flow control for API (POST), Update flow control of a Server for an API (POST)