Skip to content

API Call schema

Use this reference to identify the fields available in the apicall schema and the parser fields used to populate them.

For a field to be populated in Sophos XDR, the corresponding parser field must be present in the source data.

Schema summary

Property Value
Schema name APIcall
Parser field prefix APIcall
Supports custom parsers Yes
Schema components None defined

Schema fields

Normalized Field Type Parser Field Description
resource_id string resoureId$ Full resource string identifying the record.
tenant_id string tenantId$ ID of the tenant.
visibility Visibility visibility$ Constraints on visibility of the record.
normalizer string normalizer$ Name and version of normalizer that created this record.
sensor_type string sensorType$ Type of device that generated this event.
sensor_event_id string sensorEventId$ Event ID of original_data assigned by the sensor.
sensor_tenant string sensorTenant$ A customer ID supplied by the application that originated the data.
sensor_id string sensorId$ An ID for the data supplied by the application that originated it.
sensor_cpe string sensorCpe$ CPE of the platform producing the alert.
original_data string originalData$ Original, unadulterated data prior to any transformation.
event_time_usec uint64 eventTimeUsec$ Event time in microseconds (µs).
ingest_time_usec uint64 IngestTimeUsec$ Ingest time in microseconds (µs).
event_time_fidelity TimeFidelity eventTimeFidelity$ Specifies the original precision of the time used to populate event_time_usec.
host_id string hostId$ The host ID that uniquely identifies the host where the event originated, such as IPv(4/6) address or device MAC address.
was_modification_allowed bool wasModificationAllowed$
process_id string processId$ Identifier provided by the OS for the running process.
process_create_time_usec uint64 parentCreateTimeUsec$ Create time of process in µs.
process_correlation_id string processCorrelationId$ Process correlation ID to protect against rolling IDs.
action string action$ Action taken on the file, such as created, deleted, and updated.
commandline string commandline$ Full command line of the process that made the file modification.
function_called string functionCalled$ The function that the process attempted to call.
was_operation_successful bool wasOperationSuccessful$ Whether the call to the function was successful.
sensor_version string sensorVersion$ The agent version as string.
normalizer_version string normalizerVersion$ The normalizer version (git tag).
normalizer_revision string normalizerRevision$ The normalizer revision (git commit hash).
os OperatingSystem $os.$os Operating system that is the architecture of the user's machine
enrichments Enrichments enrichments$ Event enrichments.
win_rpc WinRPCInfo Set when this APICall event was part of a Windows RPC call.