How to export API endpoints logs as a CSV

Understanding how your applications interact with the RunCloud API is important for troubleshooting, optimization, and security. RunCloud’s API Endpoint Logs provide a detailed, chronologically ordered record of every API request your applications or scripts make.

This logging system offers invaluable insights into each interaction’s success or failure. It allows you to quickly identify and resolve issues, track usage patterns, and ensure the integrity of your API integrations.

Follow the steps below to export your RunCloud API access logs:

Step 1: Access WordPress Settings

Start by logging in to your WordPress dashboard and select the desired workspace.  In the left-hand sidebar menu, locate and click the “Settings” button to open the settings page.

Step 2: Navigate to API Management

Once in the Settings area, find and click on “API Management“. This section manages API keys and related settings for the current RunCloud workspace.

Step 3: Locate and Access Endpoint Logs

On the API Management screen, look for a button labeled “Endpoint Logs“. Click this to access the log viewing interface.

Step 4: Download the Logs

The Endpoint Logs screen will display a list of API calls. RunCloud provides options to filter these logs by month and/or username. Use these filters if necessary to narrow down the data you need.

Once you’ve located the needed logs, find and click the “Download” button. This will initiate the download of the logs to your computer in the CSV format.

Step 5: View Exported Data

The exported CSV file can be viewed in any text editor or spreadsheet software. It contains several columns. Let’s understand what each of them represents:

• API Key: A human-readable name or identifier associated with the API key.
• User: This field contains the name of the user who initiated the API request.
• Path: This is the endpoint targeted in the API request. For example, api/v3/servers is the path used to request for server information.
• Method: The HTTP method used (GET, POST, PUT, DELETE, etc.).
• Response Code: The HTTP status code returned by the server. 200 indicates success, while 404 indicates a “Not Found” error.
• IP Address: The IP address from which the API request originated. This helps identify the source of requests and potential security threats.
• Time: The timestamp of the API request, including date and time in UTC. This allows for a chronological analysis of API usage.

If you have any other questions or need help – please feel free to get in touch with our 24/7 support team. We’re here to help!