Monitor APIs and API Firewall instances

There are two types of dashboards 42Crunch Platform that all users can use to monitor their APIs:

• Collection dashboard: This dashboard is mainly fed by data from API Security Audit and API Conformance Scan, and it focuses on the quality and security of your API definitions in that particular API collection.
• Security dashboard: This API-specific dashboard is fed by data from API Firewall transaction logs, and it focuses on the API traffic to the protected APIs. To have data, you must first deploy an API Firewall instance to protect your API.

In addition, organization administrators also have executive dashboard that provides statistics on all APIs in their organization in 42Crunch Platform. This dashboard also shows APIs' compliance to security quality gates (SQGs) that they must pass.

Organization administrators have access to view and modify all API collections in their organization. This means that all API collections in an organization are visible to all organization administrators like the collections were their own, both on the API Collections page and in the monitoring dashboards. If an organization has several API collections, we recommend using more descriptive collection names that just organization and company name to be able to tell all collections apart.

View statistics for API collections

You can get statistics on the quality and security of your APIs in a particular API collection from the dashboard charts based on results from Security Audit and Conformance Scan.

1. Go to the API collection you want, and click Collection dashboard. You can see charts for all APIs in that API collection.



2. Click the toggles to change the view in the charts. If you hover on the charts, you see additional information in tool tips.

View security dashboards

After you have deployed the protection for your API, you can monitor the API Firewall instances currently protecting your API as well as the API traffic to it in 42Crunch Platform.

1. In 42Crunch Platform, click API Firewall instances. You can see all active API Firewall instances currently protecting your APIs.
   • The instances that 42Crunch Platform can communicate with are marked green to indicate they are running normally.
   • The instances that 42Crunch Platform cannot communicate with are marked red to indicate they are not available for the platform to check their status.
   • Stopped API Firewall instances are not shown: when an API Firewall instance is stopped, its container exists and the instance is automatically removed from the list.

   The development of this view is still ongoing and it is only available to organization administrators. Regular users can still view API Firewall instances protecting their APIs by going the API they want and clicking Protection > Active instances.

   

2. To view the details of an instance, click the deployment name.



3. For at-a-glance view of the main trends with the protected API, click Security dashboards.

   

View executive dashboard

You can check the statistics on the executive dashboard in 42Crunch Platform to get an overall view of the quality and status of all APIs in your organization.

Executive dashboard is only available for organization administrators.

1. In the main menu on the left, click Dashboards.
2. On the Executive summary tab, you can see statistics on API quality, such as are APIs passing the quality criteria of your security quality gates. You can also export the executive summary as a PDF for sharing, or view it full screen, for example, to present it to others in a meeting.

   

3. On the Trends tab, you can see the trends in Security Audit, Conformance Scan, and API Protection. Use the filters on the left to choose what data is shown in the charts. If you hover on the charts, you see additional information in tool tips.

   

View API transaction trace

You can use Trace Explorer to view the detailed trace of the blocked API transactions of any protected API you have access to.

You can also get to the transaction logs from the Protection tab of the API.

By default, API Firewall publishes logs to 42Crunch Platform, so that you can monitor the real-time traffic in the dashboards and Trace Explorer. However, you can also switch the logs destination for an API Firewall deployment to a directory you mount to it. For more details, see Switch logs destination for API Firewall logs.

Delete transaction logs

Depending on the nature of your API, transaction logs could include personally identifiable information that falls under, for example, GDPR regulations. To facilitate the requirements from these regulations, such as the right to forget, it is possible to delete transaction logs from 42Crunch Platform.

1. In 42Crunch Platform, go to view the transaction logs from the API Firewall instance you want.
2. Click Delete.
3. Select the cut-off time for the logs to delete, and click Delete.

All transaction logs produced by that API Firewall instance that are older than the time you selected are permanently deleted from 42Crunch Platform. Transaction logs that are newer than the time you selected are retained and the firewall instance continues to write transaction logs as before.

Logs written to other destinations than 42Crunch Platform (files, STDOUT) are not affected and need to be separately deleted as necessary. Access and error logs that API Firewall also produces are not affected, only transaction logs.