Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TeamCity Audit API

Query audit log entries

TeamCity Audit API is one of 17 APIs that TeamCity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Audit. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a JSON-LD context, and 1 JSON Schema.

This API exposes 1 operation across 1 path, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 2024.12.1.

Requests are made against a single base URL, https://{server}/app/rest.

1 operations 1 paths 7 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2024.12.1
Base URL
https://teamcity.example.com/app/rest
Authentication
HTTP Bearer, HTTP Basic
Contact
Resource Areas
1

Authentication & Security 2

TeamCity Audit API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication using access tokens
  • basicAuth — HTTP Basic authentication with username and password

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Audit 1

Query audit log entries

GET
/audit
Get Audit Events
getAuditEvents 4 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are User (8 properties), AuditEvent (5 properties), Group (5 properties), Role (3 properties). Each schema is shown below with its type and property counts.

User
object
8 properties
AuditEvents
object
2 properties
Role
object
3 properties
Group
object
5 properties
Groups
object
2 properties
AuditEvent
object
5 properties
Roles
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teamcity-audit-api-openapi.yml Raw ↑

Other APIs TeamCity publishes across the network.

TeamCity Agent Pools API
TeamCity Agents API
TeamCity Build Configurations API
TeamCity Build Queue API
TeamCity Builds API
TeamCity Changes API
TeamCity Cloud API
TeamCity Investigations API
TeamCity Mutes API
TeamCity Problems API
TeamCity Projects API
TeamCity Server API