Post audit event

POST

/api/v1/audit

• Local development server

Writes a custom audit event. Integrators can set source, project scope, and structured data. Source defaults to “external” if omitted.

Request Body ^required

Audit event to record

One of:

object

object

object

Audit event to record

object

agentType

AgentType scopes the event to an agent type (e.g. “claude-code”, “codex”). Optional.

string

attrs

Attrs carries key-value metadata.

object

key

additional properties

data

Data carries a raw JSON payload for structured event data.

Array<integer>

event

Event is a snake_case identifier for the event type (e.g. “deployment_started”). Required.

string

level

Level is the severity (“info”, “warn”, “error”). Defaults to “info” if omitted.

string

message

Message is a human-readable description.

string

projectId

ProjectID associates the event with a project. Optional.

string

source

Source identifies the origin of the event. Must be a valid AuditSource value. Defaults to “external” if omitted.

string

worktree

Worktree associates the event with a worktree. Optional.

string

Responses

204

No Content

400

Bad Request

object

code

string

Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL

error

string

500

Internal Server Error

object

code

string

Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL

error

string