Skip to content

Create Audit Event

POST
/v1/audit/events
curl --request POST \
--url https://example.com/v1/audit/events \
--header 'Content-Type: application/json' \
--data '{ "tenant_id": "example", "event_type": "example", "severity": "info", "actor_type": "system", "actor_id": "example", "resource_type": "example", "resource_id": "example", "payload": {} }'
x-api-key
Any of:
string
Media typeapplication/json
AuditEventUpsertIn
object
tenant_id
required
Tenant Id
string
>= 1 characters
event_type
required
Event Type
string
severity
Severity
string
default: info
Allowed values: info warning error
actor_type
Actor Type
string
default: system
actor_id
Any of:
string
resource_type
Any of:
string
resource_id
Any of:
string
payload
Payload
object
key
additional properties
any

Successful Response

Media typeapplication/json
AuditEventOut
object
tenant_id
required
Tenant Id
string
id
required
Id
string
event_type
required
Event Type
string
severity
required
Severity
string
Allowed values: info warning error
actor_type
required
Actor Type
string
actor_id
Any of:
string
resource_type
Any of:
string
resource_id
Any of:
string
payload
required
Payload
object
key
additional properties
any
created_at
required
Created At
string format: date-time
Example
{
"severity": "info"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}