API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Audit Logs

Get Audit Log

client.AuditLogs.Get(ctx, auditLogID) (*AuditLog, error)

GET/v1/audit_logs/{audit_log_id}

List Audit Logs

client.AuditLogs.List(ctx, query) (*Cursor[AuditLog], error)

GET/v1/audit_logs

ModelsExpand Collapse

type AuditLog struct{…}

Audit log entry.

ID string

Unique identifier for the audit log entry.

Action string

The action that was performed.

Actor AuditLogActor

The entity that performed the action.

ID string

Unique identifier for the actor.

Name string

Display name of the actor.

Type AuditLogType

Type of actor.

One of the following:

const AuditLogTypeUser AuditLogType = "user"

const AuditLogTypeAPIKey AuditLogType = "api_key"

ClientIP string

Client IP address.

CreatedAt Time

When the action occurred.

formatdate-time

Method string

HTTP method of the request.

Path string

Request path.

StatusCode int64

HTTP status code of the response.

UserAgent string

User agent string.

Target AuditLogTargetOptional

The target resource of the action.

ID string

Unique identifier for the target resource.

Type string

Type of the target resource.

type AuditLogActor struct{…}

The entity that performed the action.

ID string

Unique identifier for the actor.

Name string

Display name of the actor.

Type AuditLogType

Type of actor.

One of the following:

const AuditLogTypeUser AuditLogType = "user"

const AuditLogTypeAPIKey AuditLogType = "api_key"

type AuditLogList struct{…}

Items []AuditLog

ID string

Unique identifier for the audit log entry.

Action string

The action that was performed.

Actor AuditLogActor

The entity that performed the action.

ID string

Unique identifier for the actor.

Name string

Display name of the actor.

Type AuditLogType

Type of actor.

One of the following:

const AuditLogTypeUser AuditLogType = "user"

const AuditLogTypeAPIKey AuditLogType = "api_key"

ClientIP string

Client IP address.

CreatedAt Time

When the action occurred.

formatdate-time

Method string

HTTP method of the request.

Path string

Request path.

StatusCode int64

HTTP status code of the response.

UserAgent string

User agent string.

Target AuditLogTargetOptional

The target resource of the action.

ID string

Unique identifier for the target resource.

Type string

Type of the target resource.

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

type AuditLogTarget struct{…}

The target resource of the action.

ID string

Unique identifier for the target resource.

Type string

Type of the target resource.

type AuditLogType string

Type of actor.

One of the following:

const AuditLogTypeUser AuditLogType = "user"

const AuditLogTypeAPIKey AuditLogType = "api_key"