Skip to content

auditing

get-audit-records

Get audit records

Returns a list of audit records. The list can be filtered to include items:

  • where each item in filter has at least one match in any of these fields:

    • summary
    • category
    • eventSource
    • objectItem.name If the object is a user, account ID is available to filter.
    • objectItem.parentName
    • objectItem.typeName
    • changedValues.changedFrom
    • changedValues.changedTo
    • remoteAddress

    For example, if filter contains man ed, an audit record containing summary": "User added to group" and "category": "group management" is returned.

  • created on or after a date and time.

  • created or or before a date and time.

Permissions required: Administer Jira global permission.

GET /rest/api/3/auditing/record

FlagTypeRequiredDescription
--filterstringNoThe strings to match with audit field content, space separated.
--fromstringNoThe date and time on or after which returned audit records must have been created. If to is provided from must be before to or no audit records are returned.
--limitstringNoThe maximum number of results to return.
--offsetstringNoThe number of records to skip before returning the first result.
--tostringNoThe date and time on or before which returned audit results must have been created. If from is provided to must be after from or no audit records are returned.

Example:

bash
jr auditing get-audit-records