Dome Systems

Export

Configure batch export destinations, continuous SIEM streaming, formats, schedules, and forwarder health

Export configures batch destinations, schedules, and forwarder health so retained audit records reach your SIEM or object store. Continuous SIEM streaming is a separate forward-only path.

Overview

Forwarders and one-shot destination pushes read the same audit trail. Configuration and runtime events ship together unless you filter.

Refer to Audit events to query or reconstruct events, including gateway decisions. Refer to Audit events concept for the unified trail model. Ad-hoc exports to stdout or a file use dome audit export and dome_audit_export.

The typical workflow is:

  1. Choose a format your downstream pipeline understands.
  2. Configure a destination and store its credentials as integration secrets.
  3. Schedule recurring exports or push once with the export REST endpoint.
  4. Inspect export runs and monitor forwarder health.
  5. Optionally stream audit evidence to a SIEM for continuous Datadog or Grafana Loki delivery.

Map SIEM fields when you consume OCSF or CEF. Ingest external audit events when systems outside the gateway must contribute to the same trail.

The sections below cover formats, destinations, schedules, run inspection, forwarder health, SIEM field mapping, and external ingestion.

Requirements

Before you begin:

  • Authenticate to Dome and select a workspace
  • Have destination credentials ready to store as integration secrets
  • Know which format and connector your pipeline requires

Permissions

Export configuration and schedules require platform permissions for integrations and audit export. Each operation states what it configures or returns.

Default rolesPermissionGrants
admin, operatorintegrations.manageConfigure export destinations and related settings
admin, operator, securityaudit.exportRun and schedule audit export; enable or resume SIEM streams
All workspace rolesaudit.viewList SIEM streams and read stream status

Choose a format

Pick the format your downstream pipeline understands. Destination connectors and the CLI / MCP export surfaces accept the same values where noted.

FormatExtensionContent-TypeUse for
jsonl.jsonlapplication/x-ndjsonNDJSON, one event per line for log shippers, tail -f, and jq. CLI / MCP only.
json.jsonapplication/jsonPretty-printed JSON array for archives.
csv.csvtext/csvSpreadsheet-friendly flat rows. File-based connectors only.
ocsf.ocsf.jsonapplication/jsonOCSF v1.1.0 for Splunk, Microsoft Sentinel, and Google Chronicle.
cef.ceftext/plainCommon Event Format for ArcSight, QRadar, and generic syslog.

CLI and MCP exports page until the requested cap or cursor exhaustion. They fail instead of writing a silently shortened artifact when a page is incomplete, a cursor repeats, or the request would exceed 10,000 events. A payload type newer than the client is preserved as unresolved; it does not remove the event.

Configure a destination

Configure an export integration before creating a schedule. Each destination reads the same audit query and serializes matching events in its selected format. Refer to Audit events for the filter model those queries use.

ConnectorFormatsDestination
Amazon S3csv, json, ocsf, cefBucket + prefix. Object key suffixed with the format extension
Google Cloud Storagecsv, json, ocsf, cefBucket + prefix. Object key suffixed with the format extension
Datadog Logsjson, ocsf, cefDatadog Log Intake API (Cloud SIEM consumes ocsf natively. CSV is rejected)

Write connector credentials as integration secrets, then push once with the export REST endpoint.

POST /v1/audit/export
Content-Type: application/json

{
  "instance_id": "{{INTEGRATION_INSTANCE_ID}}",
  "connector": "s3",
  "format": "ocsf",
  "filter": {
    "start_time": "2026-05-01T00:00:00Z",
    "end_time":   "2026-06-01T00:00:00Z"
  }
}

The handler validates format up front and rejects unknown values with 400. S3 and GCS write a single object per call, named <start>_to_<end>.<ext> under the configured prefix. Datadog batches events in groups of 1000 to the Log Intake API.

Schedule recurring exports

Create an audit_export job for the configured destination. Set the interval, time, format, and event filters together.

POST /api/v1/workspaces/{{WORKSPACE_ID}}/jobs
Content-Type: application/json

{
  "job_type": "audit_export",
  "config": {
    "instance_id": "{{INTEGRATION_INSTANCE_ID}}",
    "format": "ocsf",
    "filters": {
      "event_classes": ["EVENT_CLASS_GOVERNING"]
    }
  },
  "interval_value": 1,
  "interval_unit": "day",
  "time_of_day": "02:00",
  "enabled": true
}

You can use hour, day, week, or month intervals. Weekly schedules accept day_of_week. Daily, weekly, and monthly schedules use UTC time_of_day.

Update or disable a schedule with PATCH /api/v1/workspaces/{{WORKSPACE_ID}}/jobs/{{JOB_ID}}. Delete it when the forwarder should stop permanently.

Inspect export runs

Read a scheduled job to inspect its ten most recent runs.

GET /api/v1/workspaces/{{WORKSPACE_ID}}/jobs/{{JOB_ID}}

Each run reports running, success, or failed, plus start time, finish time, error, and result. Investigate failures before the next scheduled window.

List every export schedule in a workspace.

GET /api/v1/workspaces/{{WORKSPACE_ID}}/jobs?job_type=audit_export

Monitor forwarder health

Treat a configured integration as connected, then use recent run state to assess delivery. The table below maps each state to the next action.

StateAction
Not configuredCreate credentials and an integration instance.
No runs yetConfirm the schedule is enabled and wait for its first window.
RunningCheck again after the current window completes.
SuccessVerify the destination received the expected object or batch.
FailedRead the run error, repair credentials or destination settings, and retry.

The dashboard's Integration & Forwarder Health panel lists available export destinations and their connection state.

Stream audit evidence to a SIEM

Continuous SIEM streaming delivers new audit evidence to Datadog or Grafana Loki as it is accepted. It is separate from batch export above and from webhooks.

Streaming is forward-only from the moment you enable it. Dome does not backfill history. Your organization plan must include SIEM streaming.

Connect Datadog or Grafana Loki under Integrations in the dashboard first. CLI and MCP can list connected instances, then enable and manage the stream.

Permissions

Default rolesPermissionGrants
All workspace rolesaudit.viewList streams and read status
admin, operator, securityaudit.exportEnable, disable, or resume a stream

Enable and manage a stream

Mutations require audit.export. Status and list require audit.view.
dome audit siem list
dome audit siem enable <slug-or-id>
dome audit siem status <slug-or-id>
dome audit siem disable <slug-or-id>
dome audit siem resume <slug-or-id>

enable creates a stream. If one already exists (running or stopped), enable is refused — use resume. disable stops delivery but keeps the cursor, so backlog while off remains deliverable. resume --skip-to-now abandons undelivered backlog permanently (requires --yes non-interactively).

Reference: dome audit siem

Tools: dome_audit_siem_list, dome_audit_siem_enable, dome_audit_siem_status, dome_audit_siem_disable, dome_audit_siem_resume

Open the Datadog or Grafana Loki integration instance and use the SIEM stream controls on that page.

Delivery states include active, erroring, and paused. Dome can auto-pause after sustained delivery failure or a retention gap. Resume after you repair the destination.

enabled is the delivery switch; state is retained health. Read them together. A disabled stream can retain state=active because it was healthy when stopped, and proto JSON can omit enabled=false. It is not delivering unless enabled=true. A destination has no stream until its first enable, so list omits never-enabled destinations and status returns not found.

Resume without --skip-to-now is refused whenever the retained cursor has aged out, even if the stream never reached a recorded retention_gap pause. The refusal itself is authoritative; do not infer whether skipping is required only from paused_reason.

Do not confuse this with dome audit stream, which is the live investigation tail in the dashboard or terminal.

Map SIEM fields

OCSF and CEF exports carry the request-origin fields from the audit envelope so SOC pivots by IP, user agent, or HTTP verb work without re-joining sources. Configuration events typically populate these fields. Many gateway decisions leave request_surface unset. Refer to Audit events concept for why attribution differs by event type.

Audit envelopeOCSF (ocsf)CEF (cef)
request_surface.source_ipsrc_endpoint.ipsrc
request_surface.user_agentunmapped.dome_user_agentrequestClientApplication
request_surface.http_methodunmapped.dome_http_methodrequestMethod
actor.idactor.user.uidsuid

Ingest external audit events

External systems push audit events into the unified trail via the REST ingestion endpoint, consolidating agent activity from systems outside the gateway. Refer to Audit events to query ingested events.

Next steps

On this page

Was this page helpful?