Logs API Reference

Access and Audit logs capture the logs of user actions and configuration changes within an organization. Two types of logs are provided:

API access logs: Generated through Compass API calls
Audit logs: Generated through Compass Portal operations

All the Log API data will be available for six months.

Prerequisites

To use Audit and Access Logs, you need an Administrator API Key. Write to the Compass Support Team, compass.support@core42.ai, to receive an Administrator API Key.

List Access Logs

List user actions and configuration changes within this organization.

URL

GET https://api.core42.ai/logs/v1/admin/access_logs?limit=100&gte=0

Authentication

1 curl --location --request GET 'https://api.core42.ai/logs/v1/admin/access_logs?limit=100&gte=0' 

2 --header 'api-key: **********'

Request Parameters

Name	Required	Type	Description
limit	false	integer	A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 20.
gte	true	integer	Return only events whose created_at (Unix seconds) is greater than or equal to this value.

Response Parameters

Name	Required	Type	Description
created_at	true	timestamp	The Unix timestamp of the log.
actor.api_key.id	true	string	The ID of the api_key used in the request.
actor.api_key.masked	true	string	The masked value of the api_key used in the request.
actor.ip_address	true	string	The IP address from which the action was performed.
actor.user_agent	true	string	Browser, device, or API client making the request.
request.endpoint	true	string	The endpoint of the request.
request.model	true	string	The model of the request.
request.method	true	string	Request method GET, POST, PUT, DELETE, etc.
request.status	true	string	HTTP response code (200, 401, 403, 500).
request.err_msg	true	object#	The error message of the request if applicable.

Audit Logs