Usage Guide
Learn the fundamentals of audit log record management.
You can jump straight to a specific section of the guide, or follow the description below to get started.
Basic Workflow
It is quite simple to start managing audit log records with Auditum.
First, you need to create a project. A project is a logical grouping of records. For example, you can create a project for each of your applications.
Then, you can start creating audit log records in the project. This is the most important part, as you will need to map your application data to audit log records.
After you have created records, you can query them on demand. The API for searching records is quite flexible to meet your needs. And Auditum is designed to scale with your data, so you should expect fast responses even with tons of records.
Optionally, you can configure Auditum to enable updating and deleting records, if your requirements allow it. However, we recommend that you keep the records immutable to ensure data integrity.
And that's it! Now you are able to manage audit log records with Auditum.
📄️ Create Project
To create a project, send POST request to /projects.
📄️ Create Records
Records can be created in two ways: creating one record or a batch of records.
📄️ Search Records
To search records, send GET request to /projects//records.
📄️ Update Records
By default, audit log records are considered immutable. This means that once a record is created, it cannot be updated.
📄️ Delete Records
By default, audit log records are considered immutable. This means that once a record is created, it cannot be deleted.