Ana içeriğe geç

Application Log Cleanup Tasks

Info

Various data may need to be logged in Apinizer. This data may not be meaningful after a certain period and may cause database growth. It will be beneficial to clean the collections given below at regular intervals.

If this operation is desired to be done automatically, the setting for logs to be deleted can be made from this screen. For active records, a task that runs at the beginning of each hour if hour is selected, or at 00:00 each night if day is selected, deletes relevant records before the specified date.

Application Log Cleanup Tasks

Configuration Fields

The fields used for Application Log Cleanup Task configuration are shown in the table below:

FieldDescription
Manager LogsSets how old Manager application software logs that occur during operation will be deleted.
Gateway LogsSets how old Gateway application software logs that occur during operation will be deleted.
Cache LogsSets how old Cache application software logs that occur during operation will be deleted.
TCP Connectivity Test HistorySets how old TCP connectivity test results will be deleted.
Alert LogsSets how old log records belonging to Alarms created on Apinizer will be deleted.
Token RequestsSets how old records of requests made to get tokens will be deleted.
API Security EventsSets how old records of Gateway requests blocked by a policy or failed with an error, kept for the Security Events screen, will be deleted.
API Access EventsSets how old records of every request that passed through the Gateway, successful ones included, kept for the API Access tab of the Security Events screen, will be deleted. Disabled by default. This collection receives one row per request, so keep the period short — 3 to 7 days — rather than matching the 30 days that suits API Security Events.
Portal Login LogsSets how old records of API Portal sign-ins, sign-outs and account lockout/password events, kept for the API Portal Login Logs screen, will be deleted. Disabled by default; while it stays off, no portal login record is ever deleted.
Audit RecordsSets how old records kept for the Audit Records screen will be deleted. Disabled by default (365 days once enabled); while it stays off, no audit record is ever deleted. Set the period according to your organization's own regulatory retention obligations — data-protection law, a sector regulation such as BDDK, ISO 27001, or PCI DSS, or an internal records policy — rather than for storage convenience alone.
Login RecordsSets how old records kept for the Login Records screen will be deleted. Disabled by default (365 days once enabled), with the same regulatory consideration as Audit Records above. A record produced by unmasking a pseudonymized AI value is never deleted by this setting, even while it is enabled, because that record also serves as the compliance trail for the unmask action itself.
Anomaly Detector LogsSets how old log records belonging to anomaly detection operations created on Apinizer will be deleted.
Uptime Monitor LogsSets how old log records belonging to uptime monitoring operations created on Apinizer will be deleted.
Task Flow LogsSets how old log records belonging to Task Flow operations created on Apinizer will be deleted.
Report LogsSets how old log records belonging to report operations created on Apinizer will be deleted.
API Proxy Trace LogsSets when log records kept when Trace feature is active in API traffic will be deleted.
API Manager User Token BlacklistSets when the records kept when logging out from API Manager will be deleted.

These are not ordinary log records: they are what stops a signed-out session from being resumed with the same token. A period shorter than the longest token the installation can issue (24 hours, or 30 days when Remember Me is used) is therefore extended automatically — otherwise deleting the record would make an already signed-out token valid again. A longer period is applied exactly as configured.
User NotificationsUser Notifications are kept in the notification_user collection.
Environment(Namespace) MetricsEnvironment(Namespace) Metrics are kept in the environment_metric collection.
Identity Synchronization HistorySets how old the durable record of identity provider (LDAP / Database / API / OIDC) synchronization runs will be deleted. Disabled by default; while it stays off, no run record is ever deleted.
Warning

ACL audit logs (history_acl) still cannot be deleted through purge jobs — they are always kept in the database; for manual cleanup, refer to the database growth management scripts.

Audit Records (audit_event) and Login Records (persistent_audit_event) are compliance logs too, but unlike history_acl they can now be given an automatic expiration period, from the Audit Records and Login Records rows above. Both stay disabled by default, so deciding whether to auto-expire either kind of record, and for how long, is left entirely to your organization's own regulatory obligations rather than being made for you.

Note

Regular operation of log cleanup tasks increases system performance and keeps database size under control.