The Audit Logs API is designed to help you access the operations audit logs which capture the key changes and activities in Compass. The activities include alerting, on-call, incident management, and other operation features.

Operations

GET/v1/logs

GET

Get audit LogsExperimental

This endpoint returns all operations audit logs in Compass, allowing retrieval of logs in a specified time range and filtering based on log level and category.

Permissions required: Permission to view Compass Audit logs using a Compass Org/Site/Product admin role

Forge and OAuth2 apps cannot access this REST resource.

Request

Query parameters

limit

integer

pageToken

string

category

string

level

string

startTime

string

Required

endTime

string

Required

Responses

This message is returned if the request is successful.

application/json

ListAuditLogResponse

GET/v1/logs

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/logs?startTime={startTime}&endTime={endTime}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "values": [
    {
      "created": "2024-02-17T11:33:34.940Z",
      "category": "Notifications",
      "summary": "Rule[Schedule Start][scheduleStart] -> [email] notification to [xyz@abc.com] Submitted to provider.",
      "level": "Information",
      "details": "{\"targetUser\": \"xyz@abc.com\"}"
    },
    {
      "created": "2024-02-17T11:35:34.940Z",
      "category": "Configuration Changes",
      "summary": "Schedule rotation [scheduleId: fa740f73, id: c124f500] added.",
      "level": "Information",
      "details": "{\"_incomingData\": {\"_httpParams\": {}, \"httpUrl\": \"/compass/v1/schedules/fa740f73\", \"incomingDataId\": \"c124f500\", \"_httpHeaders\": {\"Referer\": \"https://org.abc.com/jira/teams/70b66b25/on-call\", \"_entity\": {\"-rotationMetadata\": [{\"name\": \"Rotation1\", \"id\": \"bd6fdeb5\"}]}}}"
    }
  ],
  "count": 5000,
  "links": {
    "next": "/logs?startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T15:30:00Z&limit=5000&pageToken=WzE3MDgxNjk0M"
  }
}