API - Auditing logs

Display auditing logs

We can use GET vault_rest/audit/{start}/{count} endpoint to fetch and search audit logs.

start- starting record to return

count- number of records to return

sort_column= Name of column to use when sorting data

sort_direction= Sorting direction

find= Free text search string

findB64= Free text search string (Base64 encoded)

Powershell
Response
    
​x
    
 
try {    $headers = @{        Authorization = "Bearer $token"        sort_column = "Name of column to use when sorting data"        sort_direction = "Sorting direction"        find = "Free text search string"        findB64 = "Free text search string (Base64 encoded)"    }  $response = Invoke-RestMethod -Uri "$baseUrl/audit/0/5" -Headers $headers -Method Get        # Prints output as JSON object    Write-Host ( $response  | ConvertTo-Json | Out-String)    # Prints output as Table    Write-Output $response.items | Select-Object date, location, event, status, user, description | Format-Table -AutoSize​} catch {    Write-Host "Error Status Code: $($_.Exception.Response.StatusCode.Value__)"    Write-Host "Error Message: $($_.Exception.Message)"    return}
Copy

Export auditing logs

Powershell
    
try {    $headers = @{        Authorization = "Bearer $token"    }  $response = Invoke-RestMethod -Uri "$baseUrl/audit/export" -Headers $headers -Method Get  -OutFile "C:\Users\user\Documents\audit.csv"    } catch {    Write-Host "Error Status Code: $($_.Exception.Response.StatusCode.Value__)"    Write-Host "Error Message: $($_.Exception.Message)"    return}
Copy

Last updated on

Was this page helpful?

API - Auditing logs

Display auditing logs

Export auditing logs

This Website Uses Cookies

Functional Cookies

Performance Cookies

Strictly Necessary Cookies

Targeting Cookies