How do I check the API logs?

Modified on Mon, 15 Feb 2021 at 11:16 AM

In order to inspect the API Logs in illuminate, you must have a role with permission to access the API Log module. If you have permission, access the module from the menu on the left side of the screen. Once in the API Log module, you will see a chart of the recent errors, queries, and latency of your system. Below that, Illuminate displays a table which can be set to either display your API Logs either by API or by consumer. From here, you can sort the table either via the search bar at the top, or by click one of the columns to arrange by ascending or descending order. To view the failure or success logs of an entry, simply click on the number in the corresponding column. 


As of Illuminate 3.2, an additional feature will occur if you select an API from the logs screen, a new screen will be opened that shows the input and response headers as well as a step-by-step walkthrough of the API's execution, highlighting exactly where in the execution an error occurred as well as the corresponding error message. In this example, that error message is indicating that the tables the API is trying to access do not exist on the database provider selected for the API.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article