Skip to main content
GET
/
v1
/
organizations
/
audit
/
logs
List Audit Logs
curl --request GET \
  --url https://api.mixpeek.com/v1/organizations/audit/logs
{
  "results": [
    {
      "audit_id": "<string>",
      "timestamp": "<unknown>",
      "resource_type": "<string>",
      "resource_id": "<string>",
      "action": "<string>",
      "actor_id": "<string>",
      "actor_type": "user",
      "status": "success",
      "changes": "<unknown>",
      "ip_address": "<string>",
      "user_agent": "<string>"
    }
  ],
  "total": 123,
  "skip": 123,
  "limit": 123
}

Headers

Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Query Parameters

resource_type
enum<string> | null

Filter by resource type

Available options:
organization,
user,
api_key,
namespace,
collection,
bucket,
retriever,
cluster,
taxonomy,
storage_connection
resource_id
string | null

Filter by resource ID

actor_id
string | null

Filter by actor ID

action
enum<string> | null

Filter by action

Available options:
user_created,
user_updated,
user_deleted,
api_key_created,
api_key_rotated,
api_key_revoked,
api_key_scope_updated,
permission_updated,
storage_connection_created,
storage_connection_updated,
storage_connection_deleted,
storage_connection_tested,
storage_connection_failed,
namespace_created,
namespace_updated,
namespace_deleted,
namespace_accessed,
collection_created,
collection_updated,
collection_deleted,
collection_accessed,
bucket_created,
bucket_updated,
bucket_deleted,
bucket_accessed,
retriever_created,
retriever_updated,
retriever_deleted,
retriever_accessed,
retriever_queried,
cluster_created,
cluster_updated,
cluster_deleted,
cluster_executed,
cluster_accessed,
taxonomy_created,
taxonomy_updated,
taxonomy_deleted,
taxonomy_accessed
start
string | null

ISO8601 start timestamp

end
string | null

ISO8601 end timestamp

skip
integer
default:0

Number of results to skip

Required range: x >= 0
limit
integer
default:50

Number of results to return

Required range: 1 <= x <= 1000

Response

Successful Response

Response for listing audit events.

results
AuditEventResponse · object[]
required

Audit events

total
integer
required

Total count matching filters

skip
integer
required

Number of results skipped

limit
integer
required

Number of results returned