overlane enterprise audit export

Writes the whole log as CSV (every row with the hashes that chain it) and a manifest with the row count and the head hash. Exporting is itself recorded in the audit log. Check the files later with overlane enterprise audit verify.

Usage

overlane enterprise audit export [--out FILE] [--dry-run]

Flags

Flag	Type	Required	Default	Description
`--out`	string	no	`audit.csv`	Where to write the CSV (default audit.csv); the manifest goes beside it as FILE.manifest.json
`--dry-run`	boolean	no		Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane enterprise audit export --out audit-2026-10.csv

Behavior

Effect: write (changes local or hosted state).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: no.
Machine-readable description: overlane schema enterprise audit export.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "file": {
          "type": "string"
        },
        "manifestFile": {
          "type": "string"
        },
        "manifest": {
          "type": "object",
          "properties": {
            "tenantId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128,
              "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
              "description": "tenant identifier"
            },
            "exportId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "format": {
              "type": "string",
              "const": "csv"
            },
            "count": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "firstSeq": {
              "anyOf": [
                {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                {
                  "type": "null"
                }
              ]
            },
            "lastSeq": {
              "anyOf": [
                {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                {
                  "type": "null"
                }
              ]
            },
            "head": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^[0-9a-f]{64}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "exportedAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          "required": [
            "tenantId",
            "exportId",
            "format",
            "count",
            "firstSeq",
            "lastSeq",
            "head",
            "exportedAt"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "file",
        "manifestFile",
        "manifest"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.