Product PingIntelligence for APIs 5.1 Capability API Security Advanced API Cybersecurity Linux On-Premises Operating System Hosting Environment
To customize the discovery process, configure the discovery parameters on the Dashboard.
Navigate to Settings > Discovered APIs.
Discovery settings consists of the following three parts:
Mode - Configure the mode in which APIs are published to ASE.
The mode can be Manual or Auto.
Discovery Configuration - Switch discovery ON or OFF,
configure the subpath depth of the API base path and discovery interval.
Default API Properties - Configure the default properties of
discovered APIs. You can edit the properties of an individual API in manual mode
before publishing it to ASE.
The following sections explain each part of Discovery settings in detail.
Mode
Configure the mode in which Dashboard publishes the discovered APIs to ASE. The two modes
are:
Manual: In manual mode, you can review the discovered
APIs, edit the properties of the APIs and then publish one or more APIs. For
more information on editing the discovered APIs, see Edit the discovered APIs.
Auto: In auto mode, Dashboard automatically publishes the
APIs after a configured time interval. In auto mode, if you edit an API, it is
published in the subsequent interval. Configure the following for auto mode:
Polling Interval - The time interval at which
Dashboard publishes APIs to ASE. It is a good practice to have a minimum
of a 10-minute interval.
Delete non-discovered APIs - When enabled, any
APIs manually added to ASE are deleted.
ASE Deployment - Displays the ASE deployment mode -
inline or sideband.
Discovery Configuration
Enable or disable discovery from the Discovery Configuration tab by
toggling the AI Engine Discovery button. Configure the
following:
Discovery Source - the source for newly discovered
APIs. Different options are available based on the platform:
PingIntelligence for APIs software supports three sources:
AI Engine Discovery - Toggle the button to start or
stop API discovery. Make sure a root API is configured in ASE for the AI
engine to discover APIs. For more information on discovery process, see
API discovery and configuration.
AI Engine Subpath Depth - Defines the number of
subpaths used to uniquely discover the base path of a new API. The maximum
allowed value is 6 when ASE is deployed in inline mode and it is 10 when ASE
is deployed in sideband mode. For more information, see Discovery Subpaths.
AI Engine Discovery Update Interval - Defines the
time interval at which new discovered APIs are updated in the Dashboard. The
minimum value is 1-hour.
Default API Properties
You can configure the default API JSON properties from this tab. These properties apply to all
discovered APIs. You can edit the properties of the discovered APIs in
manual mode before publishing. For more information on
the API properties, see Define an API
JSON.
