Tags are a medium to let ASE know which APIs from the API ecosystem need to be processed for monitoring and attack detection. Tags are also required for cookie and login URL parameters to be captured by PingIntelligence Dashboard for adding to ASE API JSON definition.

Tagging the API for AI processing:

You need to configure ping_ai tag for all the APIs for which you want the traffic to be processed using the AI engine. For example, if you have 10 APIs in your ecosystem and you want only 5 APIs traffic to be processed using the AI engine, then apply the ping_ai tag on those 5 APIs.

In the Axway API Manager, click on Frontend API > API tab. In the API tab, navigate to Tags section and add the following tag and value:

  • ping_ai – Set it to true if you want the traffic for API to be processed by PingIntelligence
  • ping_blocking – This parameter defines whether the enable_blocking in ASE API JSON is set to true or false when the PingIntelligence Dashboard fetches the API definition from Axway. The default value is true. If you want to disable blocking in ASE, set it to false.

Tags for Cookie and Login URL (Optional)

If your APIs use a cookie or log in URL then configure the following two tags and values for a cookie and login URL. In the Axway API Manager, click Frontend API > API tab. In the API tab, navigate to Tags section and add the following tag and value:

  • ping_cookie – JSESSIONID
  • ping_login – yourAPI/login
Note: If the API has API Key or OAuth2 token configured, the PingIntelligence Dashboard automatically learns it and adds it to the API JSON definition. You do not need to configure any tags for API Key and OAuth2 token.

The following illustration shows the tags to be added: