Read a redacted command-center audit posture summary.
Read-only command-center audit summary for recent admin access and command audit rows. The response aggregates counts by role, route template, and command action, highlights sensitive admin writes and denied/error access, and avoids raw admin tokens, query values, request bodies, prompts, outputs, local URLs, and exact dynamic route IDs.
GET
/v1/admin/audit/summary
Read-only command-center audit summary for recent admin access and
command audit rows. The response aggregates counts by role, route
template, and command action, highlights sensitive admin writes and
denied/error access, and avoids raw admin tokens, query values, request
bodies, prompts, outputs, local URLs, and exact dynamic route IDs.
Authentication
API Key (header: X-B3IQ-Admin-Token)
Query Parameters
window_hours
integer
optional
query
limit
integer
optional
query
Maximum access rows and command audit rows sampled from the window.
Responses
200
Redacted audit posture summary.
application/jsonobject
string
Enum:
b3iq.admin.audit_summarygenerated_at
string (date-time)
window_hours
integer
window_start
string (date-time)
sample_limit
integer
access
object
count
integer
truncated
boolean
failed_count
integer
denied_count
integer
error_count
integer
sensitive_count
integer
by_role
object[]
Array of:
role
string
count
integer
failed_count
integer
denied_count
integer
by_path
object[]
Array of:
method
string
path_template
string
count
integer
failed_count
integer
denied_count
integer
last_seen_at
string (date-time)
recent_sensitive_events
object[]
Array of:
method
string
path_template
string
actor_role
string
status_code
integer
outcome
string
category
string
created_at
string (date-time)
commands
object
count
integer
truncated
boolean
review_event_count
integer
by_role
object[]
Array of:
role
string
count
integer
failed_count
integer
denied_count
integer
by_action
object[]
Array of:
action
string
count
integer
last_seen_at
string (date-time)
recent_review_events
object[]
Array of:
command_id
string
action
string
actor_role
string
reason_present
boolean
category
string
created_at
string (date-time)
risk
object
status
string
Enum:
clear, watch, reviewreview_action_count
integer
denied_access_count
integer
error_access_count
integer
review_actions
string[]
Array of:
default
B3IQ-native problem response.
curl -X GET 'https://{controlPlaneHost}/v1/admin/audit/summary' \ -H 'X-B3IQ-Admin-Token: YOUR_API_KEY'const response = await fetch('https://{controlPlaneHost}/v1/admin/audit/summary', { method: 'GET', headers: { "X-B3IQ-Admin-Token": "YOUR_API_KEY" }});const data = await response.json();console.log(data);
200
Response
{ "object": "b3iq.admin.audit_summary", "generated_at": "2024-01-01T00:00:00Z", "window_hours": 123, "window_start": "2024-01-01T00:00:00Z", "sample_limit": 123, "access": { "count": 123, "truncated": true, "failed_count": 123, "denied_count": 123, "error_count": 123, "sensitive_count": 123, "by_role": [ { "role": "<string>", "count": 123, "failed_count": 123, "denied_count": 123 } ], "by_path": [ { "method": "<string>", "path_template": "<string>", "count": 123, "failed_count": 123, "denied_count": 123, "last_seen_at": "2024-01-01T00:00:00Z" } ], "recent_sensitive_events": [ { "method": "<string>", "path_template": "<string>", "actor_role": "<string>", "status_code": 123, "outcome": "<string>", "category": "<string>", "created_at": "2024-01-01T00:00:00Z" } ] }, "commands": { "count": 123, "truncated": true, "review_event_count": 123, "by_role": [ { "role": "<string>", "count": 123, "failed_count": 123, "denied_count": 123 } ], "by_action": [ { "action": "<string>", "count": 123, "last_seen_at": "2024-01-01T00:00:00Z" } ], "recent_review_events": [ { "command_id": "<string>", "action": "<string>", "actor_role": "<string>", "reason_present": true, "category": "<string>", "created_at": "2024-01-01T00:00:00Z" } ] }, "risk": { "status": "clear", "review_action_count": 123, "denied_access_count": 123, "error_access_count": 123, "review_actions": [ "<string>" ] }}API Playground
Try this endpoint
GET
/v1/admin/audit/summary