Audit Logs

Audit Logs provide clear and searchable logging of all workspace changes

Quick Summary

Audit Logs provide detailed and searchable information about any changes or activity inside of a Xano workspace.

What's included in Audit Logs?

Workspace

  • Create Workspace - Create new workspaces

  • Update Workspace - Modify workspace settings

  • Reset Workspace - Reset workspace to default state

  • Read Workspace - View workspace information

  • Delete Workspace - Remove workspaces

Data Sources

  • Create Data Source - Set up new data connections

  • Update Data Source - Modify data source settings

  • Delete Data Source - Remove data sources

Branch Management

  • Create Branch - Set up new development branches

  • Update Branch - Modify branch settings

  • Delete Branch - Remove branches

  • Merge Branch - Combine branches

  • Set Live Branch - Designate the active production branch

Audit Log Retention

Depending on your plan, you'll be able to retain different amounts of audit logs.

  • Free/Build: 24h

  • Launch, Starter, Starter+ : 7 days

  • Scale, Pro, Pro +: 28 days

  • Enterprise/Custom: Unlimited

Accessing and Using Audit Logs

You can also view Audit Logs for an entire instance at once by accessing the settings from the Workspace selection screen.

Please note that if your instance has RBAC (Role-based Access Control) enabled, any users that you want to be able to view the logs need to have the Workspace Logs permission applied.

1

From the workspace dashboard, click the three dots in the top-right corner, and choose Audit Logs

2

Viewing Audit Logs

From the main view, you'll be presented with a list of all available logs.

Click on a log to view more details about that event.

On some event types, you'll have a Go To button to quickly navigate to where the change took place. The JSON playload can be useful for your own external data collection.

3

Searching and Filtering Audit Logs

You can search your Audit Logs from the search panel above the list.

Please note that the search only looks at the summary title of each event currently.

You can also use the filters to quickly narrow down specific event types, users, and labels.

4

Exporting Audit Logs

Exporting to CSV

From the top-right corner of your screen, click the three dots and choose Export CSV to export the current batch of logs as a CSV.

Using the Metadata API

There are four new endpoints available via the Metadata API to retrieve Audit Logs.

browse audit logs across all workspaces

get

browse audit logs across all workspaces Authentication: required

Authorizations
Query parameters
pageinteger · int64Optional
per_pageinteger · int64Optional
include_databooleanOptional
Responses
200

Success!

application/json
get
GET /api:meta/audit_log HTTP/1.1
Host: xcya-9xyg-koq9.dev.xano.io
Authorization: Bearer JWT
Accept: */*

{
  "items": [
    {
      "id": 1,
      "created_at": "text",
      "updated_at": "text",
      "type": "text",
      "msg": "text",
      "label": [
        "text"
      ],
      "data": {},
      "obj": {
        "type": "text",
        "id": 1
      },
      "user": {
        "id": 1,
        "email": "[email protected]"
      },
      "workspace": {
        "id": 1,
        "name": "text"
      },
      "branch": {
        "id": 1,
        "label": "text"
      }
    }
  ],
  "itemsReceived": 1,
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "offset": 1,
  "perPage": 1,
  "itemsTotal": 1,
  "pageTotal": 1
}

search audit logs across all workspaces with support for complex filtering and sorting

post

search audit logs across all workspaces with support for complex filtering and sorting Authentication: required

Authorizations
Body
pageinteger · int64OptionalDefault: 1
per_pageinteger · int64OptionalDefault: 50
include_databooleanOptional
sortobjectOptional
searchobjectOptional
Responses
200

Success!

application/json
post
POST /api:meta/audit_log/search HTTP/1.1
Host: xcya-9xyg-koq9.dev.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "page": 1,
  "per_page": 50,
  "sort": {
    "id": "desc"
  },
  "search": []
}
{
  "items": [
    {
      "id": 1,
      "created_at": "text",
      "updated_at": "text",
      "type": "text",
      "msg": "text",
      "label": [
        "text"
      ],
      "data": {},
      "obj": {
        "type": "text",
        "id": 1
      },
      "user": {
        "id": 1,
        "email": "[email protected]"
      },
      "workspace": {
        "id": 1,
        "name": "text"
      },
      "branch": {
        "id": 1,
        "label": "text"
      }
    }
  ],
  "itemsReceived": 1,
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "offset": 1,
  "perPage": 1,
  "itemsTotal": 1,
  "pageTotal": 1
}

Last updated

Was this helpful?