TeamCity REST API Reference 2025.11 Help

AuditEvent

An audit event that stores information about all meaningful actions performed by every TeamCity user.

Related Help article: Audit

Properties

id

The automatically generated unique ID of the event.

timestamp

The time of the logged event.

comment

The event summary that briefly explains its essence. Certain events (such as starting a build) have no comment attached.

action

A corresponding AuditAction object that contains additional information about this event.

relatedEntities

The list of objects associated with this change. For example, when starting a build, the only related entity is the new build instance itself. In turn, granting a role to a user generates three related entities: the user granted a new role, the role itself, and a TeamCity project for which this role was granted.

user

A TeamCity user who performed the logged event.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<auditEvent comment="runners of 'Retrieve Issues' build configuration were updated" id="94" timestamp="20250326T163632+0100"> <action id="54" name="build_type_edit_settings" pattern="#{0} build configuration settings were edited (#{1})."/> <relatedEntities count="123"> <entity>[[[relatedEntity...|relatedentity.html]]]</entity> </relatedEntities> <user email="string" enabled2FA="false" hasPassword="true" href="/app/rest/users/id:11" id="1" lastLogin="20241001T155514+0200" locator="null" name="John Doe" password="foobar" realm="string" username="johndoe"> <properties>[[[properties...|properties.html]]]</properties> <roles>[[[roleAssignments...|roleassignments.html]]]</roles> <groups>[[[groups...|groups.html]]]</groups> <avatars>[[[userAvatars...|useravatars.html]]]</avatars> </user> </auditEvent>
{ "action" : { "name" : "build_type_edit_settings", "pattern" : "#{0} build configuration settings were edited (#{1}).", "id" : "54" }, "comment" : "runners of 'Retrieve Issues' build configuration were updated", "id" : "94", "relatedEntities" : { "count" : 3, "entity" : [ { "agent" : "[[[agent...|agent.html]]]", "vcsRoot" : "[[[vcs-root...|vcsroot.html]]]", "test" : "[[[test...|test.html]]]", "change" : "[[[change...|change.html]]]", "project" : "[[[project...|project.html]]]", "type" : "type", "unknown" : true, "internalId" : "internalId", "problem" : "[[[problem...|problem.html]]]", "build" : "[[[build...|build.html]]]", "buildType" : "[[[buildType...|buildtype.html]]]", "text" : "text", "agentPool" : "[[[agentPool...|agentpool.html]]]", "user" : "[[[user...|user.html]]]", "group" : "[[[group...|group.html]]]" } ] }, "user" : { "lastLogin" : "20241001T155514+0200", "roles" : { "role" : [ "[[[roleAssignment...|roleassignment.html]]]" ] }, "groups" : { "count" : 2, "group" : [ "[[[group...|group.html]]]" ] }, "hasPassword" : true, "password" : "foobar", "enabled2FA" : false, "name" : "John Doe", "realm" : "realm", "id" : 1, "href" : "/app/rest/users/id:11", "locator" : "null", "email" : "email", "properties" : { "count" : 1, "property" : [ { "inherited" : true, "name" : "name", "type" : "[[[type...|type.html]]]", "value" : "value" } ], "href" : "href" }, "username" : "johndoe", "avatars" : { "urlToSize80" : "/app/rest/avatars/id:1/80/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize28" : "/app/rest/avatars/id:1/28/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize40" : "/app/rest/avatars/id:1/40/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize32" : "/app/rest/avatars/id:1/32/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize20" : "/app/rest/avatars/id:1/20/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize64" : "/app/rest/avatars/id:1/64/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize56" : "/app/rest/avatars/id:1/56/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png" } }, "timestamp" : "20250326T163632+0100" }
Last modified: 02 December 2025