PingIntelligence

ASE interfaces

There are two interfaces to configure and operate the API Security Enforcer (ASE). You can choose between the command-line interface (CLI) and the ASE REST application programming interface (API).

Diagram of ASE interfaces

ASE CLI

The bin/cli.sh script administers ASE and performs all ASE functions except starting and stopping ASE. To execute commands, enter cli.sh followed by the command name. To see a list of all commands, enter the following command into the CLI:

/opt/pingidentity/ase/bin/cli.sh

The following table lists some basic CLI commands.

Command Description

help

Displays cli.sh help. To get a list of CLI commands, run the following:

/opt/pingidentity/ase/bin/cli.sh help

version

Displays ASE’s version number. To get ASE’s version, run the following:

/opt/pingidentity/ase/bin/cli.sh version

The system returns the following information:

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

Displays ASE’s status. To get ASE’s status, run the following:

/opt/pingidentity/ase/bin/cli.sh status

The system returns the following:

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

update_password

Updates the password for ASE admin account.

For a complete list of commands, see CLI for inline ASE and CLI for sideband ASE.

After initial start-up, all configuration changes must be made using cli.sh 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, see Defining an API using API JSON configuration file in inline mode.

ASE REST API

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 back end servers, the number of APIs, and so on.

The following table lists ASE REST API.

API command type List of API commands

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)