Audit API specification (1.15.0)

Download OpenAPI specification:Download

The audit service implements the an organization log service, to observe all actions inside an organization

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security scheme type: API Key
header parameter name: API-TOKEN

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security scheme type: API Key
header parameter name: Personal-Access-Token

events

ListEvents

List all logged organization actions for passed organization id

query Parameters
organization_id
int64
limit
int64 [ 1 .. 50 ]
Default: 10

limits audit list output to passed amount.

offset
int64
Default: 0

defines the offset for pagination

Responses

200

event list payload with requested logging items

400

organization id is missing or in a wrong format

500

Unexpected database error

get /events
https://app.groupalarm.com/api/v1/audit/events

Response samples

application/json
Copy
Expand all Collapse all
{
  • "events":
    [
    ],
  • "totalEvents": 0
}