RomM · Schema

AuditPage[AuditEventSchema]

CompanyOpen SourceRetro GamingMedia ManagementDocker

Properties

Name Type Description
items array
total integer
limit integer
offset integer
max_id object
View JSON Schema on GitHub

JSON Schema

romm-audit-page-audit-event-schema-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/romm/json-schema/romm-audit-page-audit-event-schema-schema.json",
  "title": "AuditPage[AuditEventSchema]",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/romm-audit-api-openapi.yml#/components/schemas/AuditPage_AuditEventSchema_",
  "properties": {
    "items": {
      "items": {
        "$ref": "#/$defs/AuditEventSchema"
      },
      "type": "array",
      "title": "Items"
    },
    "total": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Total"
    },
    "limit": {
      "type": "integer",
      "minimum": 1.0,
      "title": "Limit"
    },
    "offset": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Offset"
    },
    "max_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Max Id"
    }
  },
  "type": "object",
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "$defs": {
    "AuditAction": {
      "type": "string",
      "enum": [
        "rom.download",
        "rom.bulk_download",
        "rom.player_load",
        "rom.play",
        "rom.upload",
        "rom.create",
        "rom.edit",
        "rom.match",
        "rom.unmatch",
        "rom.delete",
        "rom.file_delete",
        "platform.create",
        "platform.edit",
        "platform.delete",
        "firmware.upload",
        "firmware.delete",
        "config.update",
        "collection.create",
        "collection.edit",
        "collection.delete",
        "collection.add_roms",
        "collection.remove_roms",
        "smart_collection.create",
        "smart_collection.edit",
        "smart_collection.delete",
        "scan.start",
        "scan.finish",
        "scan.stop",
        "task.run",
        "auth.login",
        "auth.login_failed",
        "auth.password_reset_request",
        "auth.password_reset",
        "user.create",
        "user.register",
        "user.edit",
        "user.delete",
        "user.permissions_edit",
        "permission_group.create",
        "permission_group.edit",
        "permission_group.delete",
        "visibility.hide",
        "visibility.unhide",
        "client_token.create",
        "client_token.regenerate",
        "client_token.revoke",
        "device.approve"
      ],
      "title": "AuditAction",
      "description": "What someone, or a background job, did; the client builds its sentence from `data`."
    },
    "AuditActorKind": {
      "type": "string",
      "enum": [
        "user",
        "anonymous",
        "system"
      ],
      "title": "AuditActorKind"
    },
    "AuditCategory": {
      "type": "string",
      "enum": [
        "consumption",
        "library",
        "collections",
        "operations",
        "security"
      ],
      "title": "AuditCategory"
    },
    "AuditEventSchema": {
      "properties": {
        "id": {
          "type": "integer",
          "title": "Id"
        },
        "action": {
          "anyOf": [
            {
              "$ref": "#/$defs/AuditAction"
            },
            {
              "type": "string"
            }
          ],
          "title": "Action"
        },
        "category": {
          "anyOf": [
            {
              "$ref": "#/$defs/AuditCategory"
            },
            {
              "type": "null"
            }
          ]
        },
        "occurred_at": {
          "type": "string",
          "title": "Occurred At"
        },
        "actor_kind": {
          "anyOf": [
            {
              "$ref": "#/$defs/AuditActorKind"
            },
            {
              "type": "string"
            }
          ],
          "title": "Actor Kind"
        },
        "actor": {
          "anyOf": [
            {
              "$ref": "#/$defs/NotificationActorSchema"
            },
            {
              "type": "null"
            }
          ]
        },
        "actor_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Actor Name"
        },
        "target_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Target Type"
        },
        "target_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Target Id"
        },
        "target_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Target Name"
        },
        "ip_address": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Ip Address"
        },
        "device_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Device Id"
        },
        "device_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Device Name"
        },
        "data": {
          "additionalProperties": true,
          "type": "object",
          "title": "Data"
        }
      },
      "type": "object",
      "required": [
        "id",
        "action",
        "category",
        "occurred_at",
        "actor_kind",
        "actor",
        "actor_name",
        "target_type",
        "target_id",
        "target_name",
        "ip_address",
        "device_id",
        "device_name",
        "data"
      ],
      "title": "AuditEventSchema"
    },
    "NotificationActorSchema": {
      "properties": {
        "id": {
          "type": "integer",
          "title": "Id"
        },
        "username": {
          "type": "string",
          "title": "Username"
        },
        "avatar_path": {
          "type": "string",
          "title": "Avatar Path"
        },
        "updated_at": {
          "type": "string",
          "title": "Updated At"
        }
      },
      "type": "object",
      "required": [
        "id",
        "username",
        "avatar_path",
        "updated_at"
      ],
      "title": "NotificationActorSchema"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/romm-audit-page-audit-event-schema"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.