Skip to content
General Augment Docs

List Audit

GET
/api/v3/projects/{project_id}/audit
curl --request GET \
  --url 'https://example.com/api/v3/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/audit?kind=control_plane&limit=100&offset=0'

Return one redacted ordered stream without IP addresses or raw tool inputs.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id
string format: uuid

Query Parameters

Section titled “Query Parameters”
kind
Kind
string
default: all
Allowed values: control_plane runtime all
event_type
Any of:
string
<= 100 characters
limit
Limit
integer
default: 100 >= 1 <= 500
offset
Offset
integer
0 <= 100000

Header Parameters

Section titled “Header Parameters”
X-Admin-Key
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AuditPageV3
object
items
Items
Array<object>
AuditEventResponseV3
object
actor_id
Any of:
string
actor_type
required
Actor Type
string
created_at
required
Created At
string format: date-time
event_type
required
Event Type
string
id
required
Id
string format: uuid
kind
required
Kind
string
Allowed values: control_plane runtime
metadata
Metadata
object
key
additional properties
any
subject_id
Any of:
string
subject_type
required
Subject Type
string
success
required
Success
boolean
summary
required
Summary
string
next_offset
Any of:
integer
Example
{
  "items": [
    {
      "kind": "control_plane"
    }
  ]
}

422

Section titled “422”

Validation Error

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