AuditApi class

This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.

Constructors

AuditApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createAuditRecord({required AuditRecordCreate body}) → Future<AuditRecord>

Creates a record in the audit log.

exportAuditRecords({String? startDate, String? endDate, String? searchString, String? format}) → Future<String>

Exports audit records as a CSV file or ZIP file.

getAuditRecords({String? startDate, String? endDate, String? searchString, int? start, int? limit}) → Future<AuditRecordArray>

Returns all records in the audit log, optionally for a certain date range. This contains information about events like space exports, group membership changes, app installations, etc. For more information, see Audit log in the Confluence administrator's guide.

getAuditRecordsForTimePeriod({int? number, String? units, String? searchString, int? start, int? limit}) → Future<AuditRecordArray>

Returns records from the audit log, for a time period back from the current date. For example, you can use this method to get the last 3 months of records.

getRetentionPeriod() → Future<RetentionPeriod>

Returns the retention period for records in the audit log. The retention period is how long an audit record is kept for, from creation date until it is deleted.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setRetentionPeriod({required RetentionPeriod body}) → Future<RetentionPeriod>

Sets the retention period for records in the audit log. The retention period can be set to a maximum of 1 year.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited