Documentation

Everything you need to integrate Zikrah into your application

Getting Started

Zikrah is an enterprise-grade audit logging platform that provides cryptographic integrity verification for your application logs. Get started in minutes with our simple REST API.

Quick Setup

  1. Sign up for a Zikrah account
  2. Generate an API key from your dashboard
  3. Start logging with a simple HTTP POST
  4. View and verify your logs in the dashboard

Base URL: https://zikrah.dev/api/v1

Authentication

All API requests require authentication using your API key in the Authorization header.

Authorization: Bearer zk_your_api_key_here

Security: Keep your API keys secure and never expose them in client-side code.

API Reference

Create Log Entry

POST /api/v1/logs

Creates a new audit log entry with optional template validation.

Required Fields:

  • action - The action being logged (string)
  • resource - The resource being acted upon (string)
  • metadata - Additional data about the action (object)

Optional Fields:

  • resource_id - Specific resource identifier (string)
  • template_key - Template for validation (string)

List Log Entries

GET /api/v1/logs

Query Parameters

Parameter Type Description
page integer Page number (default: 1)
per_page integer Items per page (max: 100)
action string Filter by action
resource string Filter by resource

Get Log Entry

GET /api/v1/logs/LOG_ID

Retrieve a specific log entry with full verification details.

Templates

Templates provide structure and validation for your log entries. They ensure consistent data format and enable advanced features like automatic PII redaction.

Template Modes

Strict Mode

All defined fields are required. Extra fields are rejected.

Open Mode

Defined fields are validated, extra fields are allowed.

PII Redaction

Pro and Enterprise tiers support automatic PII redaction. Mark fields as sensitive in your template, and Zikrah will automatically detect and redact personal information like emails, phone numbers, and SSNs.

EMET Integrity Levels

EMET (Evidential Merkle Evidence Tree) provides progressive levels of cryptographic integrity verification based on your subscription tier.

1

Free Tier

  • • Basic hashing
  • • Sequential ordering
  • • 10K logs/month
2

Dev Tier

  • • Chain verification
  • • Tamper detection
  • • 50K logs/month
3

Pro Tier

  • • PII redaction
  • • Signed bundles
  • • 500K logs/month
4

Enterprise

  • • Blockchain anchoring
  • • Legal-grade proof
  • • Unlimited logs

Need help? Contact our support team

For detailed code examples and integration guides, please contact our support team.

Last updated: January 2025