Servers

Audit
 1.0.0 
OAS3

Audit log records are detailed information about actions and events, which can be provided by any service. For some pre-defined events services always create audit records and the Audit Service always saves them. Audit records have a lifespan of 30 days, after which they will be discarded.

Base path change and deprecation notice

The base path for the Audit APIs is changing (from /api/audit-service to /api/audit). The /api/audit-service/ base path will continue to function until Mon, 31 Mar 2025 23:59:59 GMT.

Additionally, several endpoints are being deprecated. Endpoints that are being deprecated include additional properties in response headers:

"Deprecation": "Tue, 31 Dec 2024 23:59:59 GMT",
"Link": "New version of API link; rel=\"alternate\"",
"Sunset": "Mon, 31 Mar 2025 23:59:59 GMT"
  • Deprecation: The date and time when a resource will be deprecated. After this date, the resource may be removed from future versions of the API.

  • Link: A link to a supported endpoint that replicates the functionality of a deprecated one.

  • Sunset: The date and time when a resource will be removed, and no longer be available.

  • Note: Media type names used in Polaris APIs were renamed and no longer include “synopsys”. Although media types that include “synopsys” were removed from the API specifications, existing endpoints will continue to support them until September 1, 2025. Please update your scripts to use the new media types.

Records

Contains APIs to get or export audit log records.

GET​/api​/audit-service​/records
Get audit log records.
GET​/api​/audit-service​/records​/export
Export audit log records as CSV.

Event Types

Contains API to get information about supported event types.

GET​/api​/audit-service​/event-types
Get available event types.

Logs

Contains APIs to get or export audit log records.

GET​/api​/audit​/logs
Get audit log records.
GET​/api​/audit​/logs​/export
Export audit log records as CSV.

Categories

Contains API to get information about supported audit categories.

GET​/api​/audit​/categories
Get available event types.

Schemas

ErrorResponse
Error
eventTypes
Records
eventTypeV1Resource
recordV1Resource
Categories
LogRecords
logRecordV1Resource
categoryV1Resource
collection