Audit Logs

Use these operations to interact with audit logs in Cortex.

Required permissions

Your API token must have the View audit logs permission.

Retrieve audit logs

get

Note: To see the complete list of possible values, please reference the available filter options for audit logs under Settings in the app. API key must have the View audit logs permission.

Authorizations

Query parameters

startTimestring · date-timeOptional

endTimestring · date-timeOptional

pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0

pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250

objectIdentifiersstring[]Optional

objectTypesstring · enumOptional

Filter by Cortex object types (CATALOG, SERVICE, TEAM, SCORECARD, etc), integration configurations (AWS_CONFIGURATION, BITBUCKET_CONFIGURATION, etc), and more.

Possible values:

actorApiKeyIdentifiersstring[]Optional

actorEmailsstring[]Optional

actorIpAddressesstring[]Optional

actorRequestTypesstring · enumOptionalPossible values:

Responses

200

Successfully retrieved audit logs

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

HTTPcURLJavaScriptPython

GET /api/v1/audit-logs HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "logs": [
    {
      "action": "CREATE",
      "actorIdentifier": "text",
      "ipAddress": "text",
      "objectIdentifier": "text",
      "objectType": "text",
      "timestamp": "2025-05-16T20:08:08.207Z"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}