Skip to main content

Reference

API Request Parameters

All query parameters are optional.

Filters

ParameterTypeDescriptionExample
plugin_idstringFilter by plugin that generated the eventcatalog
event_idstringFilter by event identifierentity-fetch
start_timeISO 8601 UTCTime range start (must end with Z). Defaults to 30 days ago.2025-01-01T00:00:00Z
end_timeISO 8601 UTCTime range end (must end with Z). Defaults to current time.2025-01-31T23:59:59Z
severity_levelarrayOne or more: low, medium, high, criticalhigh or high,critical
actor_idstringUser or service that performed the actionuser:default/john
statusenumsucceeded or failedsucceeded
actor_typeenumuser or serviceuser
request_methodstringHTTP methodGET, POST, etc.
request_urlstringHTTP URL path/api/catalog/entities
action_typestringType of actioncreate
query_typestringType of queryquery
entity_refstringBackstage entity refcomponent:default/my-service

Pagination

ParameterTypeDefaultMaxDescription
limitnumber1001000Number of results per page
offsetnumber0-Number of results to skip

API Response Fields

The API returns a JSON object with the following structure below. Results are ordered by event_time in descending order (newest first).

FieldTypeDescription
idUUIDUnique identifier for the audit event
event_timeISO 8601When the event occurred
recorded_atISO 8601When the event was recorded in the database
plugin_idstringPlugin that generated the event
event_idstringEvent identifier
severity_levelenumlow, medium, high, or critical
statusenumsucceeded or failed
actor_typeenumuser or service
actor_idstringEntity reference of the actor
request_methodstring or nullHTTP method if applicable
request_urlstring or nullHTTP URL if applicable
action_typestring or nullType of action performed
query_typestring or nullType of query
entity_refstring or nullBackstage entity reference
metaobjectAdditional event-specific metadata
totalnumberTotal number of matching events
limitnumberRequested page size
offsetnumberCurrent offset

Audit event directory in Backstage / Portal

The following audit events are emitted by plugins and tracked in Portal's audit log system. Note that Plugin ID, event time, status (succeeded or failed), actor type, actor ID, request method, request URL are all supplied by default.

PluginEvent IDDescriptionSeverityAdditional Metadata
catalogentity-fetchRetrieved entities from the cataloglow- queryType: all, by-query, by-uid, by-name, ancestry, by-refs
- meta.query (all)
- meta.uid (by-uid)
- entityRef (by-name, ancestry)
catalogentity-mutateModified entities (delete or refresh)medium- actionType: delete, refresh
- meta.entityRef (refresh)
- meta.uid (delete)
catalogentity-validateValidated an entity against catalog schemalow
catalogentity-facetsRetrieved entity facets for filtering/searchinglow
cataloglocation-fetchRetrieved location informationlow- queryType: all, by-id, by-entity
- meta.id (by-id)
- meta.locationRef (by-entity)
cataloglocation-mutateCreated or deleted catalog locationsmedium (low when meta.isDryRun is true)- actionType: create, delete
- meta.location (create)
- meta.isDryRun (create)
- meta.id (delete)
cataloglocation-analyzeAnalyzed a location without registering itlow
scaffoldertemplate-parameter-schemaRetrieved template parameter schemaslowmeta.templateRef
scaffolderaction-fetchRetrieved list of installed scaffolder actionslow
scaffoldertaskOperations related to scaffolder tasks (runs)low (for actionType get, list, stream, events, dry-run) medium (for all other actionType)- actionType: stale-cancel, execution, action, list, get, cancel, retry, stream, events, dry-run
- meta.taskId (stale-cancel, execution, get, cancel, retry, stream, events)
- meta.createdBy (execution)
- meta.taskParameters (execution)
- meta.templateRef (execution, create)
rbacpolicy-mutateRBAC policy created, edited, or deletedhigh (for actionType publish) medium (for all other actionType)- actionType: update, delete, create, publish
- meta.id (update, delete, create, publish)
- meta.includedUpdate (publish)
- meta.description (publish)
rbacpermission-checkRBAC admin authorization deniedmedium- actionType: authorize
- decision: DENY
config-managerplugin-mutateChange made to pluginmedium- actionType: add, remove, installed, uninstalled
- meta.plugin
- meta.artifactId (installed, uninstalled)
- meta.packages (installed, uninstalled)
config-managermodule-mutateChange made to modulemedium- actionType: add, remove
- meta.module
config-managerconfig-mutateChange made to configurationmedium- actionType: save, activate, patch
- meta.configId (activate)
config-manageradmin-config-mutateChange made to admin configurationmediumactionType: update, publish