APIs

Learn more about the APIs section of the Bearer Dashboard

The APIs sections of the dashboard lists all APIs Bearer has detected in your application. It can be accessed through the APIs link in the top navigation of the dashboard. Newly detected APIs show in the New APIs detected section.

Until an API is activated, Bearer will only detect that it exists and will not record any calls made to the API.

Newly added APIs are inactive by default. You can change this default behavior in the Environments configuration for your application.

Active APIs

Active APIs display monitoring data related to total calls, error rate, and response time. Here, you can sort APIs by any of these metrics, and directly access their configuration settings.

API Configuration

An APIs configuration can be accessed through the configuration link associated with the API in the New APIs detected section of the APIs screen, or from the cog icon for active APIs. You can leave the API configuration as is, or customize it to better match your needs.

Information

The Information section of an APIs configuration allows you to view the base URL, change the API's name within the dashboard, and assign tags to the API.

Tags are a great way to group APIs within the dashboard. They can be used to group by business area, parent service provider, and more.

Configuration

The configuration portion of the API settings is where you can:

  • Change the active status: APIs can be activated and deactivated at any time. When an API is deactivated, it will be moved to the Inactive APIs portion of the APIs screen.

  • Set the Business Impact: Business impact is used within the dashboard to provide a more accurate picture of your overall application health. Use business impact to express how essential the API is to your business.

  • Enable payload logging: When enabled, Bearer will log full response and request payloads for any API call that matches an anomaly, remediation, or log collection.

  • Exclude specific error codes: By default, Bearer considers any HTTP status code at 400 or above to be an error. Here, you can define specific status codes that will not be flagged as errors.

Security

In the event you would like to delete all log data related to the API, you can do so by choosing to Clean-Up Data Storage. Select the Clean button and all data will be removed. If you wish to ensure that no further data is logged for the current API, make sure to also de-activate the API.

FAQ

Which APIs does Bearer support?

Bearer works with every API. Even private or secret APIs can be monitored with Bearer. Add the Bearer Agent to your application to start monitoring now.