API Usage Logs

The API Usage log contains information such as which Vault API endpoints were called, the user name of the person who sent the request, and remaining burst limits. The API Usage log can help you troubleshoot burst limits and discover which of your integrations are causing you to hit the limit.

Note

These logs should not be used for auditing, as they are not designed with the appropriate level of restrictions. For example, if an API request fails to enter the usage log, the API call is not prevented from executing, which would be required if this log was designed for auditing. In rare cases an API call may not show up as an entry in the log, but know that all calls are accurately reflected in your burst limit counts.

You can use the Vault Toolbox plugin to retrieve the API Usage log for a single day, up to 30 days in the past, as well as analyze the log itself. Your user account must have the appropriate permissions to access the API Usage log.

Downloading API Usage Logs

Section link for Downloading API Usage Logs

To download API Usage logs:

1. Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2. Select the tab.
3. Expand Developer Logs () and double-click API Usage ().
   
4. In the dialog, select the checkbox for the dates you wish to download or click Select in the header to select all dates.
   
5. Optional: Click to refresh the list.
6. Click or OK to download the selected logs.
7. Optional: After the logs have downloaded successfully, click within the dialog to open the log in a File Viewer or to locate the folder within your project directory.

Vault Toolbox generates the API Usage logs for the specified time period. Once the operation is complete, you can access the folders containing the downloaded API Usage logs from toolbox/logs/api/{vaultid} within your project directory. The CSV file prepended with the Vault ID summarizes all API Usage log data for the date indicated. After a log has been downloaded, you can analyze it.

Analyzing API Usage Logs

Section link for Analyzing API Usage Logs

You can use the Vault Toolbox plugin to analyze API Usage logs after they have been downloaded. The resulting CSV file contains information about each API call made on the indicated date, such as the endpoint name, response status, and error messages.

To analyze API Usage logs:

1. Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2. Select the tab.
3. Expand Developer Logs () and double-click API Usage ().
4. In the dialog, previously downloaded logs are differentiated by a within the View column. To proceed with analyzing the log(s), select the checkbox for one or more downloaded logs, then click . The CSV file of the analysis will then open in your preferred spreadsheet application.
5. Optional: To clear local files from your project directory, select the checkbox for one or more downloaded logs, then click .

Once the operation is complete, you can access the analysis files for the API Usage logs from toolbox/logs/api/{vaultid}/analysis in your project directory. The CSV file appended with the date contains an analysis of all API Usage log data for that respective date.