POST /wiki/rest/api/audit

Creates a record in the audit log.

Permissions required: 'Confluence Administrator' global permission.

Servers

https://your-domain.atlassian.net

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`category`	String	No	The category of the event, which is displayed in the 'Event type' column on the audit log in the Confluence UI.
`remoteAddress`	String	Yes	The IP address of the computer where the event was initiated from.
`creationDate`	Integer	No	The creation date-time of the audit record, as a timestamp. This is converted to a date-time display in the Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current date-time.
`description`	String	No	A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence UI.
`associatedObjects[]`	Array	No	Objects that were associated with the event. For example, if the event was a space permission change then the associated object would be the space.
`associatedObjects[].name`	String	Yes
`associatedObjects[].objectType`	String	Yes
`affectedObject`	Object	No
`affectedObject.name`	String	Yes
`affectedObject.objectType`	String	Yes
`author`	Object	No	The user that actioned the event. If `author` is not specified, then all `author` properties will be set to null/empty, except for `type` which will be set to 'user'.
`author.username`	String	No	This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the deprecation notice for details.
`author.userKey`	String	No	This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the deprecation notice for details.
`author.type`	String	Yes	Set to 'user'. Possible values: `"user"` Default value: "user"
`author.displayName`	String	No	The name that is displayed on the audit log in the Confluence UI.
`author.operations`	Object	No	Always defaults to null.
`summary`	String	No	The summary of the event, which is displayed in the 'Change' column on the audit log in the Confluence UI.
`changedValues[]`	Array	No	The values that were changed in the event.
`changedValues[].name`	String	Yes
`changedValues[].hiddenOldValue`	String	No
`changedValues[].newValue`	String	Yes
`changedValues[].oldValue`	String	Yes
`changedValues[].hiddenNewValue`	String	No
`sysAdmin`	Boolean	No	Indicates whether the event was actioned by a system administrator. Default value: false

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.