TeamCity REST API Reference 2021.2 Help

Get Audit Records

This article lists REST API requests concerning audit records.

To access the records of user actions (also available on the Audit page in TeamCity), use:

GET http://<TeamCity Server host>:<port>/app/rest/audit

The request returns an AuditEvents entity which is a collection of AuditEvent entities.

You can filter records using auditLocator (typed as AuditLocator).

For example, to get the last 10 actions by the user johnsmith, use:

GET http://<TeamCity Server host>:<port>/app/rest/audit?locator=count:10,user:(username:johnsmith)

The audit locator accepts the action dimension. To get the list of supported action types, use:

GET http://<TeamCity Server host>:<port>/app/rest/audit?locator=$help
Last modified: 13 October 2021