FortWatchFortWatchDocs
Menu

Get the audit log's filters

GEThttps://api.fortwatch.ai/app/audit-log/filters
Scope audit:readOperation ID getAuditFilters

The categories, actions and actors the log can be filtered by.

Example request

curl -X GET "https://api.fortwatch.ai/app/audit-log/filters" \
  -H "Authorization: Bearer $FORTWATCH_API_KEY"

Response 200

The request succeeded.

FieldTypeDescription
categoriesrequiredobject[]
keyrequiredstring
labelrequiredstring
actionsrequiredobject[]
keyrequiredstring
categoryrequiredstring
textrequiredstringThe catalogue sentence, placeholders included
actorsrequiredobject[]
keyrequiredstring
labelrequiredstring
retentionDaysrequirednumber
json
{
  "categories": [
    {
      "key": "string",
      "label": "string"
    }
  ],
  "actions": [
    {
      "key": "string",
      "category": "string",
      "text": "string"
    }
  ],
  "actors": [
    {
      "key": "string",
      "label": "string"
    }
  ],
  "retentionDays": 1
}

Errors

400The request is not valid: a field is missing or has the wrong shape (the message names it).
401No valid credentials: the API key or access token is missing, revoked or expired (INVALID_API_KEY, INVALID_TOKEN).
403Not allowed: the key or token lacks this scope (SCOPE_REQUIRED), the route is dashboard-only (SESSION_REQUIRED), or a plan limit applies.
429Too many requests (RATE_LIMITED): wait the seconds Retry-After gives.