Reporting & AuditingAudit Logs

Audit Logs

Full audit-level detail for every API request in a namespace — used for compliance audits, security investigations, and forensic analysis.

{
  "start_date": "2024-06-01 00:00:00",
  "end_date": "2024-06-01 23:59:59"
}
{
  "data": {
    "details": [
      {
        "date": "2024-06-01",
        "requested_method": "/unmask",
        "requested_user": "bob@company.com",
        "requested_time": "2024-06-01 02:14:09",
        "status": "success",
        "input_payload": { "unmask": [{ "value": "<PER>hSw8kAEB10</PER>" }] },
        "response": { "data": [{ "value": "George Williams" }] },
        "error_log": ""
      }
    ],
    "next_page_token": null
  },
  "success": true,
  "error": { "message": "" }
}

Provides full audit-level detail for every API request made in a namespace. This is the most detailed reporting endpoint and is typically used for compliance audits, security investigations, and forensic analysis.

Endpoint

MethodEndpoint
GET{baseurl}/api/vault/namespace/reports/audit-details

Query parameters

query
start_datestring
Required

Start of the audit window. Format: YYYY-MM-DD HH:MM:SS.

query
end_datestring
Required

End of the audit window. Format: YYYY-MM-DD HH:MM:SS.

query
next_page_tokenstring

Pagination token for large result sets.

Response fields

Each item in data.details contains the audit record for one API request.

datestring
Required

Audit date in YYYY-MM-DD format. This string may be null where the date is unavailable.

requested_methodstring
Required

API called, such as /mask or /unmask. This string may be null where the method is unavailable.

requested_userstring
Required

User ID or email of the caller. This string may be null where the caller is unavailable.

requested_timestring
Required

Timestamp of the request. This string may be null where the timestamp is unavailable.

statusstring
Required

Request status, such as success or failure. This string may be null where the status is unavailable.

input_payloadobject
Required

Full request payload submitted by the caller.

responseobject
Required

Full API response returned by Protecto.

error_logstring

Error details if the request failed. This string may be empty or null when there is no error.

data.next_page_tokenstring

Pagination token for the next page of audit records. This string is null when no additional page is available.

Use cases

Use caseWhat to look for
Security investigationrequested_user, requested_method, status
Compliance auditrequested_time, input_payload, response
Incident forensicsFull request and response payloads
Unmask access review/unmask calls filtered by user
Error root cause analysisstatus=failure, error_log
Insider threat detectionFrequency of sensitive calls by a single user

Access notes

RoleAccess
Namespace AdminFull reporting and audit access
Regular UserNo access

Audit logs include full request and response payloads, which may contain sensitive data. Always use pagination for large date ranges and avoid pulling large windows repeatedly.