Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Audit Logs

Get audit Logs

This endpoint returns all operations audit logs in Jira Service Management, allowing retrieval of logs in a specified time range and filtering based on log level and category. <br> <br> Permissions required: Permission to view Jira Service Management Audit logs using a JSM Org/Site/Product admin role

get/api/{cloudId}/v1/logs

Query parameters

limitinteger

Maximum number of items to return in the response.

pageTokenstring

Token for fetching the next set of paginated results. The page token can be retrieved from the links.next key in each API response.

category'AUTOMATION' | 'INCOMING_DATA' | 'ALERTS' | 'API' | 'CONFIG_CHANGE' | 'EMAIL' | 'HEARTBEAT' | 'INCIDENT_MANAGEMENT' | 'INTEGRATION' | 'SYNC' | 'NOTIFICATION' | 'ONCALL_MANAGEMENT' | 'SERVICE' | 'USER_IMPORT' | 'ADD_USER_TO_GROUP' | 'ADD_USER_TO_ROLE'

Filter the audit logs based on the event category. Multiple categories can be passed by providing a comma-separated list of values.

level'INFORTMATION' | 'ERROR' | 'WARN'

Filter the audit logs based on the log level. Multiple log levels can be passed by providing a comma-separated list of values.

startTimestring date-time required

The starting date-time after which returned audit logs must have been created. Accepts the ISO format (yyyy-MM-dd'T'HH:mm:ssZ) (e.g. 2024-01-15T08:00:00+02:00).

endTimestring date-time required

The ending date-time before which returned audit logs must have been created. Accepts the ISO format (yyyy-MM-dd'T'HH:mm:ssZ) (e.g. 2024-01-15T08:00:00+02:00).

Response

This message is returned if the request is successful.

countinteger

Total number of audit logs in response.

Example response

{
  "values": [
    {
      "created": "2024-01-05T07:06:47.958Z",
      "message": "Escalation policy [escalation] added",
      "details": "{\"targetUser\":\"xyz@abc.com\"}",
      "category": "Integrations",
      "level": "Information"
    }
  ],
  "count": 1,
  "links": {
    "next": "/logs?startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T15:30:00Z&limit=5000&pageToken=WzE3MDgxNjk0M"
  }
}