Sign in

v2

latestOpenAPI 3.1.02026-08-06276982.8 KB
audit

Get audit logs

Retrieve audit logs based on specified filters. Returns a paginated list of audit log entries.

<Note>This API operation is available for Enterprise-tier organizations with single-tenant environments. To use it you must have audit log access permissions. Contact Instabase Support to request access to audit logs for your organization.</Note>

<Note>This API operation is not supported by the SDK but you can access it from Python by making direct REST calls, as shown in the sample code.</Note>

post/v1/auditlogs

Headers

Authorizationstring required

Bearer HTTP authentication.

Request body

startinteger nullable

Number of results to skip for pagination

sizeinteger nullable

Maximum number of results to return

log_typestring nullable

Type of audit log to filter by. Valid values include:

  • account_v2: User account creation logs
  • api_v2: API request logs
  • app_deployment_run_v2: Deployment run operation logs
  • app_deployment_v2: Deployment operation logs
  • app_v2: Automation app operation logs
  • datasource_v2: Data connection operation logs
  • login_v2: User login and authentication logs
  • oauth2_v2: OAuth token operation logs
  • org_v2: Organization role change logs
  • org_secrets_v2: Organization secrets operation logs
  • perms_v2: Membership and role change logs, for the organization, workspaces, and groups
  • projects_v2: Automation project operation logs
  • review_v2: Human review operation logs
  • workspace_v2: Workspace management operation logs

For details about tracked operations, see Viewing audit logs.

emailstring nullable

Filter logs by user email

start_timestring nullable

Start time in epoch milliseconds

end_timestring nullable

End time in epoch milliseconds

Response

Successfully retrieved audit logs

statusstring