English

SIEM Field Reference

This page describes the fields included in each Aikido issue and each activity log entry when they're sent to your connected SIEM.

For how to connect a specific SIEM, see SIEM Connectors.

Payload format

Each sync sends a JSON array, with one object per issue that matches your issue input settings. If you enable activity logs, each sync also sends one object per new activity log entry. The fields are the same across every SIEM connector.

Activity log entries have data_type set to activity_log. Issue objects don't have a data_type field, so use it to tell the two apart in your SIEM. For the activity log fields, see Activity log fields.

Core fields

FieldTypeDescription
idintegerThe individual issue's ID.
group_idintegerThe ID of the issue group this issue belongs to. Aikido groups related occurrences of the same underlying issue together.
attack_surfacestringOne of frontend, backend, docker_container, cloud, cloud_instance.
statusstringOne of open, ignored, snoozed, closed.
severitystringOne of critical, high, medium, low.
severity_scoreintegerAikido's priority score for the issue, from 1 to 100.
typestringOne of open_source, leaked_secret, cloud, cloud_instance, docker_container, iac, sast, surface_monitoring, malware, eol, scm_security, ai_pentest, ai_code_analysis, mobile, license.
rulestring or nullThe rule title, for SAST, IaC, cloud, and surface monitoring issues. Null for other types.
programming_languagestring or nullDetected from the affected file path, for example JS, PHP, PY, Java.
how_to_fixstring or nullAikido's remediation guidance for the issue, if available.

Vulnerability fields

FieldTypeDescription
cve_idstring or nullThe CVE ID, or an internal Aikido CVE ID (for example AIKIDO-2020-123) when no public CVE exists.
cve_id_aliasstring or nullThe related public CVE, when cve_id is an internal Aikido CVE ID.
affected_packagestring or nullThe affected package name, if any.
affected_filestring or nullThe affected file or target path, if any.

Location fields

Only the field group matching where the issue was found is populated; the rest are null.

FieldTypeDescription
code_repo_id, code_repo_nameinteger or null, string or nullThe code repository, for source-code issues.
container_repo_id, container_repo_nameinteger or null, string or nullThe container repository, for container issues.
cloud_id, cloud_nameinteger or null, string or nullThe cloud account, for cloud issues.
domain_id, domain_nameinteger or null, string or nullThe domain, for surface monitoring issues.
virtual_machine_id, virtual_machine_nameinteger or null, string or nullThe VM, for VM issues.

Status and timing fields

FieldTypeDescription
first_detected_atunix timestampWhen the issue was first created.
ignored_atunix timestamp or nullWhen the issue was ignored, if it has been.
closed_atunix timestamp or nullWhen the issue was closed, if it has been.
sla_remediate_byunix timestamp or nullThe SLA deadline for remediation, if one applies.
snooze_untilunix timestamp or nullWhen a snooze expires, if the issue is snoozed.
snooze_reasonstringWhy the issue is snoozed. Empty string if it isn't.
ignore_reasonsarrayWhy the issue is ignored. Empty array if it isn't. Each entry has a kind (manual_ignore, auto_ignore, rule_ignore, or api_ignore) and a human-readable reason.

Issue type metadata

issue_type_metadata is an object that's only included for some issue types, with at most one of the following keys set, matching the issue's type:

KeyFields
saststart_line, end_line
cloudresource_id, resource_name, resource_kind
surface_monitoringcve_id, package_name, package_version, evidence, evidence_description, domain_target_url
open_sourceinstalled_version, patched_versions (array)
eoleol_since (unix timestamp or null), affected_version
leaked_secretcommit, line

Example

[
  {
    "id": 1,
    "group_id": 1,
    "attack_surface": "backend",
    "status": "open",
    "severity": "critical",
    "severity_score": 90,
    "type": "open_source",
    "rule": null,
    "cve_id": "AIKIDO-2020-123",
    "cve_id_alias": "CVE-2020-7598",
    "affected_package": "minimist",
    "affected_file": "package-lock.json",
    "first_detected_at": 1700489005,
    "code_repo_id": 1,
    "code_repo_name": "test-service",
    "container_repo_id": null,
    "container_repo_name": null,
    "cloud_id": null,
    "cloud_name": null,
    "domain_id": null,
    "domain_name": null,
    "virtual_machine_id": null,
    "virtual_machine_name": null,
    "ignored_at": null,
    "closed_at": null,
    "sla_remediate_by": 1700924603,
    "snooze_until": null,
    "snooze_reason": "",
    "ignore_reasons": [],
    "issue_type_metadata": {
      "open_source": {
        "installed_version": "4.2.0",
        "patched_versions": ["4.2.6"]
      }
    },
    "how_to_fix": "Upgrade package minimist to 4.2.6 or later.",
    "programming_language": "JS"
  }
]

Activity log fields

Each activity log entry records an action taken on an issue or setting in Aikido, such as ignoring an issue or changing a setting. Aikido sends new entries in the order they happened and doesn't resend entries it already pushed.

FieldTypeDescription
data_typestringAlways activity_log.
idintegerThe activity log entry's ID.
timestampunix timestampWhen the action happened.
commentstringA human-readable description of the action.
sourcestringWhat triggered the action. One of manual, checklist, rule, auto, api.
actionstringThe action that was taken, for example ignored, snoozed, closed, re_open, or autofix_pr_created.
user_idinteger or nullThe ID of the user who took the action. Null when source is auto or api.
user_namestring or nullThe name of the user who took the action. Null when source is auto or api.
issue_idintegerThe ID of the individual issue the action applies to.
grouped_issue_idintegerThe ID of the issue group the action applies to.

Activity log actions

action is one of the following:

CategoryValues
Issue statussnoozed, unsnoozed, ignored, auto_ignored, closed, re_open, adjust_severity, sla_dates_reset
Issue remediationautofix_pr_created, overwrite_license_type, license_score_contested
Compliance pushesdrata_push, sprinto_push, thoropass_push
Exportsissues_exported, subdomains_exported
Repositories and containersrepo_activated, repo_deactivated, container_activated, container_deactivated, container_registry_activated, container_registry_deactivated
Settingsautofix_settings_changed, autoship_settings_changed, autodeploy_repo_settings_changed, autodeploy_global_settings_changed, spending_limit_changed
AI pentestpentest_paused, pentest_resumed
Code qualitycode_quality_finding_ignored, code_quality_finding_unignored
Endpoint protectionprotection_paused, protection_paused_all_devices, protection_resumed_all_devices

Activity log example

[
  {
    "data_type": "activity_log",
    "id": 42,
    "timestamp": 1713586140,
    "comment": "Rick Astley manually ignored this issue",
    "source": "manual",
    "action": "ignored",
    "user_id": 1,
    "user_name": "Rick Astley",
    "issue_id": 10,
    "grouped_issue_id": 3
  }
]