Arcane OS Docs Development only

Reference

Arcane.firewall.audit()

Returns bounded lifecycle and owned-state metadata, not packet payloads or complete per-packet attribution. Requires firewall.read.

  • Reference

This focused page is derived from the mechanically checked full member inventory.

Syntax

Arcane.firewall.audit(options?)

Parameters

Optional {limit} integer from 1 through 200

Return value

Promise<FirewallAudit>

Description

Returns bounded lifecycle and owned-state metadata, not packet payloads or complete per-packet attribution. Requires firewall.read.

Overview

Arcane.firewall.audit(options?) returns bounded Arcane Firewall lifecycle and owned-state metadata. It requires firewall.read, app id firewall, and Core. It does not return packet payloads, full per-packet attribution, credentials, or unbounded history and has no side effect or event.

options is optional. limit defaults to 100 and must be a safe integer from 1 through 200; invalid values throw TypeError before dispatch.

Result

The exact result is {records, total, truncated, coverage, warning}. warning is a string or null. Records are newest first and each is exactly {id, time, type, operation, stateGeneration, result, direction, ruleId, message}. type is "lifecycle" or "blocked"; operation is one of install, enable, disable, rollback, recover, or block; direction and ruleId may be null.

total is the retained audit count, capped at 500. truncated says the chosen limit omitted retained records; it does not claim Arcane captured every network decision.

Errors and recovery

METHOD_NOT_ALLOWED means the Firewall read boundary is absent. METHOD_CONTRACT_INPUT_INVALID indicates a malformed native request; use the public wrapper and documented limit. A damaged state record can return an empty audit with its failure in warning, allowing the UI to offer Recovery without claiming that no history exists.

Example

const audit = await Arcane.firewall.audit({limit: 50});

for (const record of audit.records) {
    console.log(record.time, record.operation, record.result, record.message);
}
if (audit.warning) {
    console.warn(audit.warning);
}

Reference group

Platform, installation, users, and system

Repository and reviewed source access