Enumerate Audit Events

Title

List of audit entries

URL Path

vault_rest/audit/{start}/{count}

Method

GET

Last Updated

08 Oct 2019

Summary

Lists audit events reported by the system.

Use Cases

Used by the UI to show a list of events reported by the system.

HTTP header parameters

Name

Value

Required

Description

Example

Authorization

The API key of the caller

REQUIRED

This header should have the following format:
Bearer [API key obtained from the authenticate API]
Example: Bearer Cp01BwnXAIOLZXxn7yogjKqIZnZpQD

GET /vault_rest/audit/0/100 HTTP/1.1
Host: localhost:8010
Authorization: Bearer jza4XRol3gcWqQyAkEwkqfxiBjCxLb
sort_column: date
sort_direction: desc
find: logged on
findB64: bG9nZ2VkIG9u

sort_column

Name of column to use when sorting data

OPTIONAL

Possible values: date, description, event, location, status, user

sort_direction

Sorting direction

OPTIONAL

Possible values: asc, desc

find

Free text search string

OPTIONAL

Free text search string

findB64

Free text search string (Base64 encoded)

OPTIONAL

Free text search string (Base64 encoded to support all charsets). Will override any value specified in 'find' header.

Method: GET

start

Zero based position in list from where to start returning data

REQUIRED

count

Maximum number of list entries to return

REQUIRED

Request Error

400

Bad Request

Invalid HTTP request

401

Invalid parameter

One or more parameters are invalid

403

Forbidden

API key is incorrect

500

Internal Server Error

Server is temporarily unavailable

Response

Example of a successful request:

{
"filter_count": 171,
"items": [
{
"audit_id": 2,
"date": "2015-08-07T14:55:30.5070000",
"description": "testUser logged off.",
"event": "Logoff",
"location": "192.168.16.117",
"status": "Success",
"user": "Test User"
},
...
],
"total_count": 171
}

Descriptions of response:

filter_count

Filtered entries count

Total number of entries in the database when a filter has been applied (no filtering is currently available in this API). If no filter is specified this value is always equal to total_count.

total_count

Total entries count

Total number of entries in the database.

items

Array of entries

 

items.audit_id

Audit unique id

 

items.event

Event

 

items.description

Description

 

items.status

Event status

 

items.date

Creation date

Date and time (in UTC) when the log entry was created.

items.role

User role

 

items.location

IP