Audit aging using REST API

Optionally, Atlas triggers Audit aging through REST API configuration. Using REST API to enable Audit aging features can be less time consuming and beneficial. By default Audit Aging is disabled through REST API.

Examples for employing REST APIs in specific scenarios:

  • For a single instance, when you can perform an audit aging process for any specific scenario without changing any scheduled audit aging configuration, you can trigger audit aging using the REST API by passing the specified audit criteria as a payload.

  • When regular configuration based Audit aging is scheduled for every 30 days, and user wants to trigger it before the next scheduled time, it can be done through REST API by passing the query parameter
    useAuditConfig
    
    

An example usage of the REST API feature:

POST /api/atlas/admin/audits/ageout?useAuditConfig=false
Payload options: 
{
    “auditAgingEnabled”:false,
    “defaultAgeoutEnabled”:false,
    “createEventsAgeoutAllowed”:false,
    “subTypesIncluded”:true,
    “defaultAgeoutAuditCount”:10,
    “defaultAgeoutTTLInDays”:30,
    “customAgeoutAuditCount”:10,
    “customAgeoutTTLInDays”:30,
    “customAgeoutEntityTypes”:”hive_table”,
    “customAgeoutActionTypes”:”ENTITY_UPDATE”,
    “auditSweepoutEnabled”:true,
    “sweepoutEntityTypes”:”hive_column”,
    sweepoutActionTypes:”CLASSIFICATION_ADD”
}