background

SpamExperts KnowledgebaseFeature Preview

Logs (Preview)

The old Software API and Control Panel API are being removed in favor of a unified, modern, API. The majority of the control panel already uses the new API, which means that changes are not visible in the old Software API logs, and instead can be found in the new API logs page. Most third-party integration still use the old Software and Control Panel APIs at this time.

The Logs (Preview) section, allows you to see what changes were made with the new API. This section is only available to Super Admin users, and is intended for use by developers of integration. The API logs may also be used to audit changes that have been made by users, but this is not the intended use of this functionality (explicit, easy-to-use auditing functionality will be added to the interface in an upcoming release). As such, this page is aimed at developers that are familiar with modern REST APIs.

In this page, you have several methods to look for API calls that were made when certain settings were added / removed  / adjusted.

You can filter by the HTTP method that was used to make the API call:

  • GET: when someone tried to review the contents of a page. Eg: look for whitelisted senders

  • POST: When someone adds a new rule. Eg: add a sender to the whitelist

  • PUT: When someone is using the Edit option to change a rule: Eg: edit a sender whitelist rule

  • DELETE: When someone removes a rule. Eg remove a sender to the whitelist. 

You can then select from several other query rules that will allow you to refine the search.

  • Timestamp - when the API call was made

  • Caller IP - the IP address that executed the API call

  • Client username - a username field that is optionally included in API calls to identify an end-user

  • Client IP - an IP field that is optionally included in API calls to identify an end-user

  • Endpoint - the API endpoint indicates what aspect of the software was changed

  • HTTP status - the response status of the API call - a 2xx response indicates success, a 4xx response indicates user error, and a 5xx response indicates an API error

  • Error code - a numeric code that narrows down exactly what error occurred (if one did)

  • Params - the data provided in the API call, when using GET, PUT, or DELETE

  • Data - the data provided in the API call, when using POST

  • Extra params - additional API options that were used (e.g. page selection)

You can also use the Customise drop down list to get more details in the results, and group results by the various fields.

Once all your query rules are in place, you can run the search to get the results. 


Was this article helpful?

Related articles

Search result for :