Providing a Reason (Auditing Data)

With each call to the API, it's also possible to specify a plain text 'reason' as to why you are executing the call, and then this Reason will be added to any relevant auditing records added.

In order to do this, you need to specify a 'Reason' header request parameter as per the PowerShell example below.

# Powershell Request (GET - Retrieving Data)
$PasswordstateUrl = 'https://passwordstate/api/passwordlists/<PasswordListID>'
Invoke-Restmethod -Method Get -Uri $PasswordstateUrl -Header @{ "APIKey" = "<apikey>"; "Reason" = "Testing" }