Skip to content
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

List the audit log

One row for each change request (each method other than GET) and each login, also when it is refused. The console keeps a row for 180 days.

GET/api/v1/audit-events
Authorization
tse_sessionAPI key · cookierequired
Query parameters
actorstring

Only the rows of this actor (without regard to case)

operationstring

Only the rows of this operation ID

sincestring<date-time>

Only the rows at or after this time

untilstring<date-time>

Only the rows before this time

limitinteger<int64>
min 1 · max 200 · default: 50
offsetinteger<int64>
min 0 · default: 0
Responses
200

OK

eventsAuditEventResponse[]required
Show properties
Array of AuditEventResponse
actorstringrequired
atstring<date-time>required
client_ipstringrequired
duration_msinteger<int64> | nullrequired

Time of the request in milliseconds. Null for a row from before 0.11.0

errorstringrequired

Error text that the client got for a 4xx or 5xx answer, at most 2 KB. The console removes credentials from it. Empty for a good answer

http_methodstringrequired
idinteger<int64>required
login_methodstringrequired
operation_idstringrequired
pathstringrequired
querystringrequired

Query string of the request, decoded. The console removes credentials from it

rolestringrequired
statusinteger<int64>required
targetstringrequired

Path parameters of the request, for example id=...

user_agentstringrequired
totalinteger<int64>required

Number of all rows that match the filters

default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/audit-events' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "events": [
    {
      "actor": "string",
      "at": "2019-08-24T14:15:22Z",
      "client_ip": "string",
      "duration_ms": 0,
      "error": "string",
      "http_method": "string",
      "id": 0,
      "login_method": "string",
      "operation_id": "string",
      "path": "string",
      "query": "string",
      "role": "string",
      "status": 0,
      "target": "string",
      "user_agent": "string"
    }
  ],
  "total": 0
}