Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Administration Guide

Viewing API Protection domain data

To view the collected domain data:

  1. Click Machine Learning > API Protection.
  2. Double-click a server policy that contains the desired API Protection policy.
  3. In the View Domain Data column of the Domain List table, click (View Domain).

The system provides three dimensions to view the API Protection domain data:

  • Overview
  • Tree View
  • API View

Overview

The Overview page displays a high level summary of data collected for the domain, including overview, Top 10 URLs by Hit, HTTP/HTTPS Request History, and Event Dashboard.

Domain overview

The top of the Overview page provides a high-level summary of the data that the machine-learning model has learned about the domain.

Parameters Description
Access Frequency

Indicates how frequent this domain is being accessed.

URL Number

The total number of URLs that the machine-learning module has learned.

Action (Alert/Block)

The total number of the alerts, including both Alert action and Alert & Deny action, that has been issued since the start time up to the present moment, as well as the percentage of each in the total number of requests.

Service(HTTP/HTTPS)

The total amount of the HTTP and the HTTPS traffic from the start time up to now.

Top 10 URLs by Hit

The Top 10 URLs by Hit chart displays the top 10 URLs for page hits counts.

HTTP/HTTPS Request History

The HTTP/HTTPS Request History chart displays the number of HTTP and HTTPS requests over the last 24 hours.

Machine Learning Events

This chart displays the API Protection events, such as sample collection, model running, new endpoints, along with the time periods when these events take place.

Tree View

The Tree View page displays the entire URL directory of the domain in a tree view. You can click on the URL path to view its API request parameters and body, and the response body.

Domain directory

The left panel of the Tree View page shows the directory structure of the domain. The / (backslash) indicates the root of the domain. You can click the + icon to unfold the directory and navigate to an API path. The API request parameters and body, and the response body will be on the right side of the Tree View page.

To edit the request parameter and body schema, see API patterns and paths.

API View

The API View displays the API data structure learned by the API Protection model. You can click Export to export the schema model to your local directory.

If you want to export the schema model as well as the configuration data, you can either:

  • Go to Policy > Server Policy, find the Machine Learning section on the server policy configuration page, select the API Protection tab, then click Export. The schema model and the configuration data for all the domains in this policy will be exported.

  • Go to Machine Learning > API Protection, select the API protection policy, click Edit to enter into the Edit API Protection Configuration page, select a domain, then click Export to export the schema model and the configuration data for this specific domain.

Viewing API Protection domain data

To view the collected domain data:

  1. Click Machine Learning > API Protection.
  2. Double-click a server policy that contains the desired API Protection policy.
  3. In the View Domain Data column of the Domain List table, click (View Domain).

The system provides three dimensions to view the API Protection domain data:

  • Overview
  • Tree View
  • API View

Overview

The Overview page displays a high level summary of data collected for the domain, including overview, Top 10 URLs by Hit, HTTP/HTTPS Request History, and Event Dashboard.

Domain overview

The top of the Overview page provides a high-level summary of the data that the machine-learning model has learned about the domain.

Parameters Description
Access Frequency

Indicates how frequent this domain is being accessed.

URL Number

The total number of URLs that the machine-learning module has learned.

Action (Alert/Block)

The total number of the alerts, including both Alert action and Alert & Deny action, that has been issued since the start time up to the present moment, as well as the percentage of each in the total number of requests.

Service(HTTP/HTTPS)

The total amount of the HTTP and the HTTPS traffic from the start time up to now.

Top 10 URLs by Hit

The Top 10 URLs by Hit chart displays the top 10 URLs for page hits counts.

HTTP/HTTPS Request History

The HTTP/HTTPS Request History chart displays the number of HTTP and HTTPS requests over the last 24 hours.

Machine Learning Events

This chart displays the API Protection events, such as sample collection, model running, new endpoints, along with the time periods when these events take place.

Tree View

The Tree View page displays the entire URL directory of the domain in a tree view. You can click on the URL path to view its API request parameters and body, and the response body.

Domain directory

The left panel of the Tree View page shows the directory structure of the domain. The / (backslash) indicates the root of the domain. You can click the + icon to unfold the directory and navigate to an API path. The API request parameters and body, and the response body will be on the right side of the Tree View page.

To edit the request parameter and body schema, see API patterns and paths.

API View

The API View displays the API data structure learned by the API Protection model. You can click Export to export the schema model to your local directory.

If you want to export the schema model as well as the configuration data, you can either:

  • Go to Policy > Server Policy, find the Machine Learning section on the server policy configuration page, select the API Protection tab, then click Export. The schema model and the configuration data for all the domains in this policy will be exported.

  • Go to Machine Learning > API Protection, select the API protection policy, click Edit to enter into the Edit API Protection Configuration page, select a domain, then click Export to export the schema model and the configuration data for this specific domain.