The Synqly Connector APIs provide a unifying interface and data model for all supported service Providers.
See the Synqly Overview for more information.
The Synqly Connector APIs provide a unifying interface and data model for all supported service Providers.
See the Synqly Overview for more information.
Add metadata to the response by invoking meta functions. Documentation for meta functions is available at https://docs.synqly.com/api-reference/meta-functions. Not all meta function are available at every endpoint.
Select a field to order the results by. Defaults to name. To control the direction of the sorting, append [asc] or [desc] to the field name. For example, name[asc] will sort the results by name in ascending order. The ordering defaults to asc if not specified.
curl -i -X GET \
'https://api.synqly.com/v1/edr/endpoints?cursor=string&filter=string&limit=0&meta=string&order=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'List of endpoint assets that match the query.
ActivityId is an enum, and the following values are allowed. 0 - Unknown: The event activity is unknown. 1 - Log: The discovered information is via a log. 2 - Collect: The discovered information is via a collection process. 99 - Other: The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.
CategoryUid is an enum, and the following values are allowed. 5 - Discovery: Discovery events report the existence and state of devices, files, configurations, processes, registry keys, and other objects.
ClassUid is an enum, and the following values are allowed. 5001 - DeviceInventoryInfo: Device Inventory Info events report device inventory data that is either logged or proactively collected. For example, when collecting device information from a CMDB or running a network sweep of connected devices.
The Device object represents an addressable computer system or host, which is typically connected to a computer network and participates in the transmission or processing of data within the computer network. Defined by D3FEND d3f:Host.
DeviceTypeId is an enum, and the following values are allowed. 0 - Unknown: The type is unknown. 1 - Server: A server. 2 - Desktop: A desktop computer. 3 - Laptop: A laptop computer. 4 - Tablet: A tablet computer. 5 - Mobile: A mobile phone. 6 - Virtual: A virtual machine. 7 - IOT: An IOT (Internet of Things) device. 8 - Browser: A web browser. 9 - Firewall: A networking firewall. 10 - Switch: A networking switch. 11 - Hub: A networking hub. 12 - Router: A networking router. 13 - IDS: An intrusion detection system. 14 - IPS: An intrusion prevention system. 15 - LoadBalancer: A Load Balancer device. 89 - ImagingEquipment: Equipment for processing optical data, such as a camera. 90 - PLC: A Programmable logic controller. 91 - SCADA: A supervisory control and data acquisition system. 92 - DCS: A distributed control system. 93 - CNC: A computer numerical control system, including computerized machine tools. 94 - ScientificEquipment: A piece of scientific equipment such as an oscilloscope or spectrometer. 95 - MedicalDevice: A medical device such as an MRI machine or infusion pump. 96 - LightingControls: A lighting control for internal or external applications. 97 - EnergyMonitoringSystem: An energy monitoring, security or safety system. 98 - TransportationDevice: A transportation device or transportation supporting device. 99 - Other: The type is not mapped. See the type attribute, which contains a data source specific value.
A list of agent objects associated with a device, endpoint, or resource.
The unique identifier of the cloud autoscale configuration.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The Container object describes an instance of a specific container. A container is a prepackaged, portable system image that runs isolated on an existing system using a container runtime like containerd.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the device was known to have been created.
The description of the device, ordinarily as reported by the operating system.
The network domain where the device resides. For example: work.example.com.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The initial discovery time of the device.
The group names to which the device belongs. For example: ["Windows Laptops", "Engineering"].
Unique name assigned to a device connected to a computer network. A domain name in general is an Internet address that can be resolved through the Domain Name System (DNS). For example: r2-d2.example.com.
The Device Hardware Information object contains details and specifications of the physical components that make up a device. This information provides an overview of the hardware capabilities, configuration, and characteristics of the device.
The name of the hypervisor running on the device. For example, Xen, VMware, Hyper-V, VirtualBox, etc.
The Image object provides a description of a specific Virtual Machine (VM) or Container image. Defined by D3FEND d3f:ContainerImage.
The International Mobile Station Equipment Identifier that is associated with the device.
Internet Protocol address (IP address), in either IPv4 or IPv6 format. For example, 192.168.200.24 or 2001:0db8:85a3:0000:0000:8a2e:0370:7334.
A list of IP addresses available on the device
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The most recent discovery time of the device.
The Geo Location object describes a geographical location, usually associated with an IP address. Defined by D3FEND d3f:PhysicalLocation.
Media Access Control (MAC) address. For example: 18:36:F3:98:4F:9A.
A list of MAC addresses available on the device
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the device was last known to have been modified.
The alternate device name, ordinarily as assigned by an administrator.
Note: The Name could be any other string that helps to identify the device, such as a phone number; for example 310-555-1234.
If running under a process namespace (such as in a container), the process identifier within that process namespace.
A list of NetBIOS names available on the device
The network interfaces that are associated with the device, one for each unique MAC address/IP address/hostname/name combination.
Note: The first element of the array is the network information that pertains to the event.
DeviceNetworkStatusId is an enum, and the following values are allowed. 1 - NotIsolated: Device is not isolated from the network. 2 - Isolated: Device is isolated from the network. 99 - Unknown: The network isolation status is unknown.
The Organization object describes characteristics of an organization or company and its division if any.
The Operating System (OS) object describes characteristics of an OS, such as Linux or Windows. Defined by D3FEND d3f:OperatingSystem.
The User object describes the characteristics of a user/person or a security principal. Defined by D3FEND d3f:UserAccount.
The region where the virtual machine is located. For example, an AWS Region.
The risk level, normalized to the caption of the risk_level_id value.
DeviceRiskLevelId is an enum, and the following values are allowed. 0 - Info 1 - Low 2 - Medium 3 - High 4 - Critical 99 - Other: The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.
The subnet represented in a CIDR notation, using the format network_address/prefix_length. The network_address can be in either IPv4 or IPv6 format. The prefix length indicates the number of bits used for the network portion, and the remaining bits are available for host addresses within that subnet.
The list of software contained on a device
The device type. For example: unknown, server, desktop, laptop, tablet, mobile, virtual, browser, plc, scada, dcs, cnc, scientific, medical, lighting, energy, transportation other.
The unique identifier of the device. For example the Windows TargetSID or AWS EC2 ARN.
An alternate unique identifier of the device if any. For example the ActiveDirectory DN.
The Organization object describes characteristics of an organization or company and its division if any.
The Metadata object describes the metadata associated with the event. Defined by D3FEND d3f:Metadata.
The Product object describes characteristics of a software product.
The Common Platform Enumeration (CPE) name as described by (NIST) For example: cpe:/a:apple:safari:16.2.
The Feature object provides information about the software product feature that generated a specific event. It encompasses details related to the capabilities, components, user interface (UI) design, and performance upgrades associated with the feature.
The two letter lower case language codes, as defined by ISO 639-1. For example: en (English), de (German), or fr (French).
Uniform Resource Locator (URL) string. For example: http://www.example.com/download/trouble.exe.
The version of the OCSF schema, using Semantic Versioning Specification (SemVer). For example: 1.0.0. Event consumers use the version to determine the available event attributes.
The Event ID or Code that the product uses to describe the event.
The OCSF Schema Extension object provides detailed information about the schema extension used to construct the event. The schema extensions are registered in the extensions.md file.
The schema extensions used to create the event.
The list of category labels attached to the event or specific attributes. Labels are user defined tags or aliases added at normalization time.
For example:["network", "connection.ip:destination", "device.ip:source"]The event log name. For example, syslog file name or Windows logging subsystem: Security.
The logging provider or logging service that logged the event. For example, Microsoft-Windows-Security-Auditing.
The event log schema version that specifies the format of the original event. For example syslog version or Cisco Log Schema Version.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the logging system collected and logged the event.
This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.An array of Logger objects that describe the devices and logging products between the event source and its eventual destination. Note, this attribute can be used when there is a complex end-to-end path of event flow.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the event was last modified or enriched.
The original event time as reported by the event source. For example, the time in the original format from system event log such as Syslog on Unix/Linux and the System event file on Windows. Omit if event is generated instead of collected via logs.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The event processed time, such as an ETL operation.
The list of profiles used to create the event. Profiles should be referenced by their name attribute for core profiles, or extension/name for profiles from extensions.
Sequence number of the event. The sequence number is a value available in some events, to make the exact ordering of events unambiguous, regardless of the event time precision.
SeverityId is an enum, and the following values are allowed. 0 - Unknown: The event/finding severity is unknown. 1 - Informational: Informational message. No action required. 2 - Low: The user decides if action is needed. 3 - Medium: Action is required but the situation is not serious at this time. 4 - High: Action is required immediately. 5 - Critical: Action is required immediately and the scope is broad. 6 - Fatal: An error occurred but it is too late to take remedial action. 99 - Other: The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
TypeUid is an enum, and the following values are allowed. 500100 - Unknown 500101 - Log: The discovered information is via a log. 500102 - Collect: The discovered information is via a collection process. 500199 - Other
The Actor object contains details about the user, role, application, service, or process that initiated or performed a specific activity.
The API, or Application Programming Interface, object represents information pertaining to an API request and response.
The event category name, as defined by category_uid value: Discovery.
The Cloud object contains information about a cloud account such as AWS Account ID, regions, etc.
The number of times that events in the same logical group occurred during the event Start Time to End Time period.
An unordered collection of attributes. It defines a set of attributes available in all objects. It can be also used as a generic object to log objects that are not otherwise defined by the schema.
The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The end time of a time period, or the time of the most recent event included in the aggregate event.
The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:
[{"name": "answers.ip", "value": "92.24.47.250", "type": "location", "data": {"city": "Socotra", "continent": "Asia", "coordinates": [-25.4153, 17.0743], "country": "YE", "desc": "Yemen"}}]The observables associated with the event or a finding.
The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.
The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The start time of a time period, or the time of the least recent event included in the aggregate event.
The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.
The event status code, as reported by the event source.
For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.
The status detail contains additional information about the event/finding outcome.
StatusId is an enum, and the following values are allowed. 0 - Unknown: The status is unknown. 1 - Success 2 - Failure 99 - Other: The event status is not mapped. See the status attribute, which contains a data source specific value.
The normalized event occurrence time or the finding creation time.
The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.
{ "result": [ { … } ], "cursor": "string", "meta": { "stats": { … }, "api": { … } } }
curl -i -X GET \
'https://api.synqly.com/v1/edr/endpoints/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Device Inventory Info events report device inventory data that is either logged or proactively collected. For example, when collecting device information from a CMDB or running a network sweep of connected devices.
ActivityId is an enum, and the following values are allowed. 0 - Unknown: The event activity is unknown. 1 - Log: The discovered information is via a log. 2 - Collect: The discovered information is via a collection process. 99 - Other: The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.
CategoryUid is an enum, and the following values are allowed. 5 - Discovery: Discovery events report the existence and state of devices, files, configurations, processes, registry keys, and other objects.
ClassUid is an enum, and the following values are allowed. 5001 - DeviceInventoryInfo: Device Inventory Info events report device inventory data that is either logged or proactively collected. For example, when collecting device information from a CMDB or running a network sweep of connected devices.
The Device object represents an addressable computer system or host, which is typically connected to a computer network and participates in the transmission or processing of data within the computer network. Defined by D3FEND d3f:Host.
DeviceTypeId is an enum, and the following values are allowed. 0 - Unknown: The type is unknown. 1 - Server: A server. 2 - Desktop: A desktop computer. 3 - Laptop: A laptop computer. 4 - Tablet: A tablet computer. 5 - Mobile: A mobile phone. 6 - Virtual: A virtual machine. 7 - IOT: An IOT (Internet of Things) device. 8 - Browser: A web browser. 9 - Firewall: A networking firewall. 10 - Switch: A networking switch. 11 - Hub: A networking hub. 12 - Router: A networking router. 13 - IDS: An intrusion detection system. 14 - IPS: An intrusion prevention system. 15 - LoadBalancer: A Load Balancer device. 89 - ImagingEquipment: Equipment for processing optical data, such as a camera. 90 - PLC: A Programmable logic controller. 91 - SCADA: A supervisory control and data acquisition system. 92 - DCS: A distributed control system. 93 - CNC: A computer numerical control system, including computerized machine tools. 94 - ScientificEquipment: A piece of scientific equipment such as an oscilloscope or spectrometer. 95 - MedicalDevice: A medical device such as an MRI machine or infusion pump. 96 - LightingControls: A lighting control for internal or external applications. 97 - EnergyMonitoringSystem: An energy monitoring, security or safety system. 98 - TransportationDevice: A transportation device or transportation supporting device. 99 - Other: The type is not mapped. See the type attribute, which contains a data source specific value.
A list of agent objects associated with a device, endpoint, or resource.
The unique identifier of the cloud autoscale configuration.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The Container object describes an instance of a specific container. A container is a prepackaged, portable system image that runs isolated on an existing system using a container runtime like containerd.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the device was known to have been created.
The description of the device, ordinarily as reported by the operating system.
The network domain where the device resides. For example: work.example.com.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The initial discovery time of the device.
The group names to which the device belongs. For example: ["Windows Laptops", "Engineering"].
Unique name assigned to a device connected to a computer network. A domain name in general is an Internet address that can be resolved through the Domain Name System (DNS). For example: r2-d2.example.com.
The Device Hardware Information object contains details and specifications of the physical components that make up a device. This information provides an overview of the hardware capabilities, configuration, and characteristics of the device.
The name of the hypervisor running on the device. For example, Xen, VMware, Hyper-V, VirtualBox, etc.
The Image object provides a description of a specific Virtual Machine (VM) or Container image. Defined by D3FEND d3f:ContainerImage.
The International Mobile Station Equipment Identifier that is associated with the device.
Internet Protocol address (IP address), in either IPv4 or IPv6 format. For example, 192.168.200.24 or 2001:0db8:85a3:0000:0000:8a2e:0370:7334.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The most recent discovery time of the device.
The Geo Location object describes a geographical location, usually associated with an IP address. Defined by D3FEND d3f:PhysicalLocation.
Media Access Control (MAC) address. For example: 18:36:F3:98:4F:9A.
A list of MAC addresses available on the device
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the device was last known to have been modified.
The alternate device name, ordinarily as assigned by an administrator.
Note: The Name could be any other string that helps to identify the device, such as a phone number; for example 310-555-1234.
If running under a process namespace (such as in a container), the process identifier within that process namespace.
A list of NetBIOS names available on the device
The network interfaces that are associated with the device, one for each unique MAC address/IP address/hostname/name combination.
Note: The first element of the array is the network information that pertains to the event.
DeviceNetworkStatusId is an enum, and the following values are allowed. 1 - NotIsolated: Device is not isolated from the network. 2 - Isolated: Device is isolated from the network. 99 - Unknown: The network isolation status is unknown.
The Organization object describes characteristics of an organization or company and its division if any.
The Operating System (OS) object describes characteristics of an OS, such as Linux or Windows. Defined by D3FEND d3f:OperatingSystem.
The User object describes the characteristics of a user/person or a security principal. Defined by D3FEND d3f:UserAccount.
The region where the virtual machine is located. For example, an AWS Region.
The risk level, normalized to the caption of the risk_level_id value.
DeviceRiskLevelId is an enum, and the following values are allowed. 0 - Info 1 - Low 2 - Medium 3 - High 4 - Critical 99 - Other: The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.
The subnet represented in a CIDR notation, using the format network_address/prefix_length. The network_address can be in either IPv4 or IPv6 format. The prefix length indicates the number of bits used for the network portion, and the remaining bits are available for host addresses within that subnet.
The list of software contained on a device
The device type. For example: unknown, server, desktop, laptop, tablet, mobile, virtual, browser, plc, scada, dcs, cnc, scientific, medical, lighting, energy, transportation other.
The unique identifier of the device. For example the Windows TargetSID or AWS EC2 ARN.
An alternate unique identifier of the device if any. For example the ActiveDirectory DN.
The Organization object describes characteristics of an organization or company and its division if any.
The Metadata object describes the metadata associated with the event. Defined by D3FEND d3f:Metadata.
The Product object describes characteristics of a software product.
The Common Platform Enumeration (CPE) name as described by (NIST) For example: cpe:/a:apple:safari:16.2.
The Feature object provides information about the software product feature that generated a specific event. It encompasses details related to the capabilities, components, user interface (UI) design, and performance upgrades associated with the feature.
The two letter lower case language codes, as defined by ISO 639-1. For example: en (English), de (German), or fr (French).
Uniform Resource Locator (URL) string. For example: http://www.example.com/download/trouble.exe.
The version of the OCSF schema, using Semantic Versioning Specification (SemVer). For example: 1.0.0. Event consumers use the version to determine the available event attributes.
The Event ID or Code that the product uses to describe the event.
The OCSF Schema Extension object provides detailed information about the schema extension used to construct the event. The schema extensions are registered in the extensions.md file.
The schema extensions used to create the event.
The list of category labels attached to the event or specific attributes. Labels are user defined tags or aliases added at normalization time.
For example:["network", "connection.ip:destination", "device.ip:source"]The event log name. For example, syslog file name or Windows logging subsystem: Security.
The logging provider or logging service that logged the event. For example, Microsoft-Windows-Security-Auditing.
The event log schema version that specifies the format of the original event. For example syslog version or Cisco Log Schema Version.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the logging system collected and logged the event.
This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.An array of Logger objects that describe the devices and logging products between the event source and its eventual destination. Note, this attribute can be used when there is a complex end-to-end path of event flow.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the event was last modified or enriched.
The original event time as reported by the event source. For example, the time in the original format from system event log such as Syslog on Unix/Linux and the System event file on Windows. Omit if event is generated instead of collected via logs.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The event processed time, such as an ETL operation.
The list of profiles used to create the event. Profiles should be referenced by their name attribute for core profiles, or extension/name for profiles from extensions.
Sequence number of the event. The sequence number is a value available in some events, to make the exact ordering of events unambiguous, regardless of the event time precision.
SeverityId is an enum, and the following values are allowed. 0 - Unknown: The event/finding severity is unknown. 1 - Informational: Informational message. No action required. 2 - Low: The user decides if action is needed. 3 - Medium: Action is required but the situation is not serious at this time. 4 - High: Action is required immediately. 5 - Critical: Action is required immediately and the scope is broad. 6 - Fatal: An error occurred but it is too late to take remedial action. 99 - Other: The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
TypeUid is an enum, and the following values are allowed. 500100 - Unknown 500101 - Log: The discovered information is via a log. 500102 - Collect: The discovered information is via a collection process. 500199 - Other
The Actor object contains details about the user, role, application, service, or process that initiated or performed a specific activity.
The API, or Application Programming Interface, object represents information pertaining to an API request and response.
The event category name, as defined by category_uid value: Discovery.
The Cloud object contains information about a cloud account such as AWS Account ID, regions, etc.
The number of times that events in the same logical group occurred during the event Start Time to End Time period.
An unordered collection of attributes. It defines a set of attributes available in all objects. It can be also used as a generic object to log objects that are not otherwise defined by the schema.
The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The end time of a time period, or the time of the most recent event included in the aggregate event.
The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:
[{"name": "answers.ip", "value": "92.24.47.250", "type": "location", "data": {"city": "Socotra", "continent": "Asia", "coordinates": [-25.4153, 17.0743], "country": "YE", "desc": "Yemen"}}]The observables associated with the event or a finding.
The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.
The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The start time of a time period, or the time of the least recent event included in the aggregate event.
The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.
The event status code, as reported by the event source.
For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.
The status detail contains additional information about the event/finding outcome.
StatusId is an enum, and the following values are allowed. 0 - Unknown: The status is unknown. 1 - Success 2 - Failure 99 - Other: The event status is not mapped. See the status attribute, which contains a data source specific value.
The normalized event occurrence time or the finding creation time.
The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.
{ "result": { "activity_id": 0, "activity_name": "string", "actor": { … }, "api": { … }, "category_name": "string", "category_uid": 0, "class_uid": 0, "cloud": { … }, "count": 0, "custom_fields": {}, "device": { … }, "duration": 0, "end_time": 0, "end_time_dt": "2019-08-24T14:15:22Z", "enrichments": [ … ], "message": "string", "metadata": { … }, "observables": [ … ], "osint": [ … ], "raw_data": "string", "severity": "string", "severity_id": 0, "start_time": 0, "start_time_dt": "2019-08-24T14:15:22Z", "status": "string", "status_code": "string", "status_detail": "string", "status_id": 0, "time": 0, "time_dt": "2019-08-24T14:15:22Z", "timezone_offset": 0, "type_name": "string", "type_uid": 0, "unmapped": {} }, "meta": { "stats": { … }, "api": { … } } }
Add metadata to the response by invoking meta functions. Documentation for meta functions is available at https://docs.synqly.com/api-reference/meta-functions. Not all meta function are available at every endpoint.
Select a field to order the results by. Defaults to name. To control the direction of the sorting, append [asc] or [desc] to the field name. For example, name[asc] will sort the results by name in ascending order. The ordering defaults to asc if not specified.
curl -i -X GET \
'https://api.synqly.com/v1/edr/applications?cursor=string&filter=string&limit=0&meta=string&order=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'List of applications that match the query.
ActivityId is an enum, and the following values are allowed. 0 - Unknown: The event activity is unknown. 1 - Log: The discovered information is via a log. 2 - Collect: The discovered information is via a collection process. 99 - Other: The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.
CategoryUid is an enum, and the following values are allowed. 5 - Discovery: Discovery events report the existence and state of devices, files, configurations, processes, registry keys, and other objects.
ClassUid is an enum, and the following values are allowed. 5090 - DeviceSoftwareInfo: Device Software Info events report device software data that is either logged or proactively collected.
The Metadata object describes the metadata associated with the event. Defined by D3FEND d3f:Metadata.
The Product object describes characteristics of a software product.
The Common Platform Enumeration (CPE) name as described by (NIST) For example: cpe:/a:apple:safari:16.2.
The Feature object provides information about the software product feature that generated a specific event. It encompasses details related to the capabilities, components, user interface (UI) design, and performance upgrades associated with the feature.
The two letter lower case language codes, as defined by ISO 639-1. For example: en (English), de (German), or fr (French).
Uniform Resource Locator (URL) string. For example: http://www.example.com/download/trouble.exe.
The version of the OCSF schema, using Semantic Versioning Specification (SemVer). For example: 1.0.0. Event consumers use the version to determine the available event attributes.
The Event ID or Code that the product uses to describe the event.
The OCSF Schema Extension object provides detailed information about the schema extension used to construct the event. The schema extensions are registered in the extensions.md file.
The schema extensions used to create the event.
The list of category labels attached to the event or specific attributes. Labels are user defined tags or aliases added at normalization time.
For example:["network", "connection.ip:destination", "device.ip:source"]The event log name. For example, syslog file name or Windows logging subsystem: Security.
The logging provider or logging service that logged the event. For example, Microsoft-Windows-Security-Auditing.
The event log schema version that specifies the format of the original event. For example syslog version or Cisco Log Schema Version.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the logging system collected and logged the event.
This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.An array of Logger objects that describe the devices and logging products between the event source and its eventual destination. Note, this attribute can be used when there is a complex end-to-end path of event flow.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the event was last modified or enriched.
The original event time as reported by the event source. For example, the time in the original format from system event log such as Syslog on Unix/Linux and the System event file on Windows. Omit if event is generated instead of collected via logs.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The event processed time, such as an ETL operation.
The list of profiles used to create the event. Profiles should be referenced by their name attribute for core profiles, or extension/name for profiles from extensions.
Sequence number of the event. The sequence number is a value available in some events, to make the exact ordering of events unambiguous, regardless of the event time precision.
The Product object describes characteristics of a software product.
The Common Platform Enumeration (CPE) name as described by (NIST) For example: cpe:/a:apple:safari:16.2.
The Feature object provides information about the software product feature that generated a specific event. It encompasses details related to the capabilities, components, user interface (UI) design, and performance upgrades associated with the feature.
The two letter lower case language codes, as defined by ISO 639-1. For example: en (English), de (German), or fr (French).
Uniform Resource Locator (URL) string. For example: http://www.example.com/download/trouble.exe.
SeverityId is an enum, and the following values are allowed. 0 - Unknown: The event/finding severity is unknown. 1 - Informational: Informational message. No action required. 2 - Low: The user decides if action is needed. 3 - Medium: Action is required but the situation is not serious at this time. 4 - High: Action is required immediately. 5 - Critical: Action is required immediately and the scope is broad. 6 - Fatal: An error occurred but it is too late to take remedial action. 99 - Other: The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
TypeUid is an enum, and the following values are allowed. 509000 - Unknown 509001 - Log: The discovered information is via a log. 509002 - Collect: The discovered information is via a collection process. 509099 - Other
The API, or Application Programming Interface, object represents information pertaining to an API request and response.
The event category name, as defined by category_uid value: Discovery.
The Cloud object contains information about a cloud account such as AWS Account ID, regions, etc.
The number of times that events in the same logical group occurred during the event Start Time to End Time period.
An unordered collection of attributes. It defines a set of attributes available in all objects. It can be also used as a generic object to log objects that are not otherwise defined by the schema.
The Device object represents an addressable computer system or host, which is typically connected to a computer network and participates in the transmission or processing of data within the computer network. Defined by D3FEND d3f:Host.
The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The end time of a time period, or the time of the most recent event included in the aggregate event.
The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:
[{"name": "answers.ip", "value": "92.24.47.250", "type": "location", "data": {"city": "Socotra", "continent": "Asia", "coordinates": [-25.4153, 17.0743], "country": "YE", "desc": "Yemen"}}]The observables associated with the event or a finding.
The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.
The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The start time of a time period, or the time of the least recent event included in the aggregate event.
The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.
The event status code, as reported by the event source.
For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.
The status detail contains additional information about the event/finding outcome.
StatusId is an enum, and the following values are allowed. 0 - Unknown: The status is unknown. 1 - Success 2 - Failure 99 - Other: The event status is not mapped. See the status attribute, which contains a data source specific value.
The normalized event occurrence time or the finding creation time.
The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.
{ "result": [ { … } ], "cursor": "string", "meta": { "stats": { … }, "api": { … } } }
curl -i -X POST \
https://api.synqly.com/v1/edr/endpoints/actions/quarantine \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"state": "Connect",
"endpoint_ids": [
"string"
]
}'{ "result": [ "string" ], "meta": { "stats": { … }, "api": { … } } }
Add metadata to the response by invoking meta functions. Documentation for meta functions is available at https://docs.synqly.com/api-reference/meta-functions. Not all meta function are available at every endpoint.
Select a field to order the results by. Defaults to name. To control the direction of the sorting, append [asc] or [desc] to the field name. For example, name[asc] will sort the results by name in ascending order. The ordering defaults to asc if not specified.
Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.
curl -i -X GET \
'https://api.synqly.com/v1/edr/threats?cursor=string&filter=string&include_raw_data=true&limit=0&meta=string&order=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'List of threats that match the query.
ActivityId is an enum, and the following values are allowed. 0 - Unknown: The event activity is unknown. 1 - Create: A finding was created. 2 - Update: A finding was updated. 3 - Close: A finding was closed. 99 - Other: The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.
CategoryUid is an enum, and the following values are allowed. 2 - Findings: Findings events report findings, detections, and possible resolutions of malware, anomalies, or other actions performed by security products.
ClassUid is an enum, and the following values are allowed. 2004 - DetectionFinding: A Detection Finding describes detections or alerts generated by security products using correlation engines, detection engines or other methodologies. Note: if the product is a security control, the security_control profile should be applied and its attacks information should be duplicated into the finding_info object.
The Finding Information object describes metadata related to a security finding generated by a security tool or system.
A title or a brief phrase summarizing the reported finding.
The Analytic object contains details about the analytic technique used to analyze and derive insights from the data or information that led to the creation of a finding or conclusion.
The MITRE ATT&CK® technique and associated tactics related to the finding.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the finding was created.
A list of data sources utilized in generation of the finding.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the finding was first observed. e.g. The time when a vulnerability was first observed.
It can differ from the created_time timestamp, which reflects the time this finding was created.
The Cyber Kill Chain® provides a detailed description of each phase and its associated activities within the broader context of a cyber attack.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the finding was most recently observed. e.g. The time when a vulnerability was most recently observed.
It can differ from the modified_time timestamp, which reflects the time this finding was last modified.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the finding was last modified.
The unique identifier of the product that reported the finding.
Other analytics related to this finding.
Describes events and/or other findings related to the finding as identified by the security product.
Uniform Resource Locator (URL) string. For example: http://www.example.com/download/trouble.exe.
The Metadata object describes the metadata associated with the event. Defined by D3FEND d3f:Metadata.
The Product object describes characteristics of a software product.
The Common Platform Enumeration (CPE) name as described by (NIST) For example: cpe:/a:apple:safari:16.2.
The Feature object provides information about the software product feature that generated a specific event. It encompasses details related to the capabilities, components, user interface (UI) design, and performance upgrades associated with the feature.
The two letter lower case language codes, as defined by ISO 639-1. For example: en (English), de (German), or fr (French).
Uniform Resource Locator (URL) string. For example: http://www.example.com/download/trouble.exe.
The version of the OCSF schema, using Semantic Versioning Specification (SemVer). For example: 1.0.0. Event consumers use the version to determine the available event attributes.
The Event ID or Code that the product uses to describe the event.
The OCSF Schema Extension object provides detailed information about the schema extension used to construct the event. The schema extensions are registered in the extensions.md file.
The schema extensions used to create the event.
The list of category labels attached to the event or specific attributes. Labels are user defined tags or aliases added at normalization time.
For example:["network", "connection.ip:destination", "device.ip:source"]The event log name. For example, syslog file name or Windows logging subsystem: Security.
The logging provider or logging service that logged the event. For example, Microsoft-Windows-Security-Auditing.
The event log schema version that specifies the format of the original event. For example syslog version or Cisco Log Schema Version.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the logging system collected and logged the event.
This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.An array of Logger objects that describe the devices and logging products between the event source and its eventual destination. Note, this attribute can be used when there is a complex end-to-end path of event flow.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the event was last modified or enriched.
The original event time as reported by the event source. For example, the time in the original format from system event log such as Syslog on Unix/Linux and the System event file on Windows. Omit if event is generated instead of collected via logs.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The event processed time, such as an ETL operation.
The list of profiles used to create the event. Profiles should be referenced by their name attribute for core profiles, or extension/name for profiles from extensions.
Sequence number of the event. The sequence number is a value available in some events, to make the exact ordering of events unambiguous, regardless of the event time precision.
SeverityId is an enum, and the following values are allowed. 0 - Unknown: The event/finding severity is unknown. 1 - Informational: Informational message. No action required. 2 - Low: The user decides if action is needed. 3 - Medium: Action is required but the situation is not serious at this time. 4 - High: Action is required immediately. 5 - Critical: Action is required immediately and the scope is broad. 6 - Fatal: An error occurred but it is too late to take remedial action. 99 - Other: The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
TypeUid is an enum, and the following values are allowed. 200400 - Unknown 200401 - Create: A finding was created. 200402 - Update: A finding was updated. 200403 - Close: A finding was closed. 200499 - Other
ActionId is an enum, and the following values are allowed. 0 - Unknown: The action was unknown. The disposition_id attribute may still be set to a non-unknown value, for example 'Count', 'Uncorrected', 'Isolated', 'Quarantined' or 'Exonerated'. 1 - Allowed: The activity was allowed. The disposition_id attribute should be set to a value that conforms to this action, for example 'Allowed', 'Approved', 'Delayed', 'No Action', 'Count' etc. 2 - Denied: The attempted activity was denied. The disposition_id attribute should be set to a value that conforms to this action, for example 'Blocked', 'Rejected', 'Quarantined', 'Isolated', 'Dropped', 'Access Revoked, etc. 99 - Other: The action was not mapped. See the action attribute, which contains a data source specific value.
The Actor object contains details about the user, role, application, service, or process that initiated or performed a specific activity.
The API, or Application Programming Interface, object represents information pertaining to an API request and response.
An array of MITRE ATT&CK® objects describing the tactics, techniques & sub-techniques identified by a security control or finding.
Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.
The event category name, as defined by category_uid value: Findings.
The Cloud object contains information about a cloud account such as AWS Account ID, regions, etc.
The confidence, normalized to the caption of the confidence_id value. In the case of 'Other', it is defined by the event source.
ConfidenceId is an enum, and the following values are allowed. 0 - Unknown: The normalized confidence is unknown. 1 - Low 2 - Medium 3 - High 99 - Other: The confidence is not mapped to the defined enum values. See the confidence attribute, which contains a data source specific value.
The number of times that events in the same logical group occurred during the event Start Time to End Time period.
An unordered collection of attributes. It defines a set of attributes available in all objects. It can be also used as a generic object to log objects that are not otherwise defined by the schema.
The Device object represents an addressable computer system or host, which is typically connected to a computer network and participates in the transmission or processing of data within the computer network. Defined by D3FEND d3f:Host.
The disposition name, normalized to the caption of the disposition_id value. In the case of 'Other', it is defined by the event source.
DispositionId is an enum, and the following values are allowed. 0 - Unknown: The disposition is unknown. 1 - Allowed: Granted access or allowed the action to the protected resource. 2 - Blocked: Denied access or blocked the action to the protected resource. 3 - Quarantined: A suspicious file or other content was moved to a benign location. 4 - Isolated: A session was isolated on the network or within a browser. 5 - Deleted: A file or other content was deleted. 6 - Dropped: The request was detected as a threat and resulted in the connection being dropped. 7 - CustomAction: A custom action was executed such as running of a command script. Use the message attribute of the base class for details. 8 - Approved: A request or submission was approved. For example, when a form was properly filled out and submitted. This is distinct from 1 'Allowed'. 9 - Restored: A quarantined file or other content was restored to its original location. 10 - Exonerated: A suspicious or risky entity was deemed to no longer be suspicious (re-scored). 11 - Corrected: A corrupt file or configuration was corrected. 12 - PartiallyCorrected: A corrupt file or configuration was partially corrected. 13 - Uncorrected: A corrupt file or configuration was not corrected. 14 - Delayed: An operation was delayed, for example if a restart was required to finish the operation. 15 - Detected: Suspicious activity or a policy violation was detected without further action. 16 - NoAction: The outcome of an operation had no action taken. 17 - Logged: The operation or action was logged without further action. 18 - Tagged: A file or other entity was marked with extended attributes. 19 - Alert: The request or activity was detected as a threat and resulted in a notification but request was not blocked. 20 - Count: Counted the request or activity but did not determine whether to allow it or block it. 21 - Reset: The request was detected as a threat and resulted in the connection being reset. 22 - Captcha: Required the end user to solve a CAPTCHA puzzle to prove that a human being is sending the request. 23 - Challenge: Ran a silent challenge that required the client session to verify that it's a browser, and not a bot. 24 - AccessRevoked: The requestor's access has been revoked due to security policy enforcements. Note: use the Host profile if the User or Actor requestor is not present in the event class. 25 - Rejected: A request or submission was rejected. For example, when a form was improperly filled out and submitted. This is distinct from 2 'Blocked'. 26 - Unauthorized: An attempt to access a resource was denied due to an authorization check that failed. This is a more specific disposition than 2 'Blocked' and can be complemented with the authorizations attribute for more detail. 27 - Error: An error occurred during the processing of the activity or request. Use the message attribute of the base class for details. 99 - Other: The disposition is not mapped. See the disposition attribute, which contains a data source specific value.
The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time of the most recent event included in the finding.
The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:
[{"name": "answers.ip", "value": "92.24.47.250", "type": "location", "data": {"city": "Socotra", "continent": "Asia", "coordinates": [-25.4153, 17.0743], "country": "YE", "desc": "Yemen"}}]Describes various evidence artifacts associated to the activity/activities that triggered a security detection.
The Firewall Rule object represents a specific rule within a firewall policy or event. It contains information about a rule's configuration, properties, and associated actions that define how network traffic is handled by the firewall.
The impact , normalized to the caption of the impact_id value. In the case of 'Other', it is defined by the event source.
ImpactId is an enum, and the following values are allowed. 0 - Unknown: The normalized impact is unknown. 1 - Low 2 - Medium 3 - High 4 - Critical 99 - Other: The impact is not mapped. See the impact attribute, which contains a data source specific value.
A list of Malware objects, describing details about the identified malware.
The observables associated with the event or a finding.
The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.
The Remediation object describes the recommended remediation steps to address identified issue(s).
Describes details about resources that were the target of the activity that triggered the finding.
The risk level, normalized to the caption of the risk_level_id value.
RiskLevelId is an enum, and the following values are allowed. 0 - Info 1 - Low 2 - Medium 3 - High 4 - Critical 99 - Other: The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.
The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time of the least recent event included in the finding.
The normalized status of the Finding set by the consumer normalized to the caption of the status_id value. In the case of 'Other', it is defined by the source.
The event status code, as reported by the event source.
For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.
The status detail contains additional information about the event/finding outcome.
StatusId is an enum, and the following values are allowed. 0 - Unknown: The status is unknown. 1 - New: The Finding is new and yet to be reviewed. 2 - InProgress: The Finding is under review. 3 - Suppressed: The Finding was reviewed, determined to be benign or a false positive and is now suppressed. 4 - Resolved: The Finding was reviewed, remediated and is now considered resolved. 99 - Other: The event status is not mapped. See the status attribute, which contains a data source specific value.
The normalized event occurrence time or the finding creation time.
The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.
An unordered collection of attributes. It defines a set of attributes available in all objects. It can be also used as a generic object to log objects that are not otherwise defined by the schema.
{ "result": [ { … } ], "cursor": "string", "meta": { "stats": { … }, "api": { … } } }
Add metadata to the response by invoking meta functions. Documentation for meta functions is available at https://docs.synqly.com/api-reference/meta-functions. Not all meta function are available at every endpoint.
Select a field to order the results by. Defaults to name. To control the direction of the sorting, append [asc] or [desc] to the field name. For example, name[asc] will sort the results by name in ascending order. The ordering defaults to asc if not specified.
Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.
curl -i -X GET \
'https://api.synqly.com/v1/edr/alerts?cursor=string&filter=string&include_raw_data=true&limit=0&meta=string&order=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'List of alerts that match the query.
Account Change events report when specific user account management tasks are performed, such as a user/role being created, changed, deleted, renamed, disabled, enabled, locked out or unlocked.
ActivityId is an enum, and the following values are allowed. 0 - Unknown: The event activity is unknown. 1 - Create: A user/role was created. 2 - Enable: A user/role was enabled. 3 - PasswordChange: An attempt was made to change an account's password. 4 - PasswordReset: An attempt was made to reset an account's password. 5 - Disable: A user/role was disabled. 6 - Delete: A user/role was deleted. 7 - AttachPolicy: An IAM Policy was attached to a user/role. 8 - DetachPolicy: An IAM Policy was detached from a user/role. 9 - Lock: A user account was locked out. 10 - MFAFactorEnable: An authentication factor was enabled for an account. 11 - MFAFactorDisable: An authentication factor was disabled for an account. 99 - Other: The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.
CategoryUid is an enum, and the following values are allowed. 3 - AccessManagement: Identity & Access Management (IAM) events relate to the supervision of the system's authentication and access control model. Examples of such events are the success or failure of authentication, granting of authority, password change, entity change, privileged use etc.
ClassUid is an enum, and the following values are allowed. 3001 - AccountChange: Account Change events report when specific user account management tasks are performed, such as a user/role being created, changed, deleted, renamed, disabled, enabled, locked out or unlocked.
The Metadata object describes the metadata associated with the event. Defined by D3FEND d3f:Metadata.
The Product object describes characteristics of a software product.
The Common Platform Enumeration (CPE) name as described by (NIST) For example: cpe:/a:apple:safari:16.2.
The Feature object provides information about the software product feature that generated a specific event. It encompasses details related to the capabilities, components, user interface (UI) design, and performance upgrades associated with the feature.
The two letter lower case language codes, as defined by ISO 639-1. For example: en (English), de (German), or fr (French).
Uniform Resource Locator (URL) string. For example: http://www.example.com/download/trouble.exe.
The version of the OCSF schema, using Semantic Versioning Specification (SemVer). For example: 1.0.0. Event consumers use the version to determine the available event attributes.
The Event ID or Code that the product uses to describe the event.
The OCSF Schema Extension object provides detailed information about the schema extension used to construct the event. The schema extensions are registered in the extensions.md file.
The schema extensions used to create the event.
The list of category labels attached to the event or specific attributes. Labels are user defined tags or aliases added at normalization time.
For example:["network", "connection.ip:destination", "device.ip:source"]The event log name. For example, syslog file name or Windows logging subsystem: Security.
The logging provider or logging service that logged the event. For example, Microsoft-Windows-Security-Auditing.
The event log schema version that specifies the format of the original event. For example syslog version or Cisco Log Schema Version.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the logging system collected and logged the event.
This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.An array of Logger objects that describe the devices and logging products between the event source and its eventual destination. Note, this attribute can be used when there is a complex end-to-end path of event flow.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the event was last modified or enriched.
The original event time as reported by the event source. For example, the time in the original format from system event log such as Syslog on Unix/Linux and the System event file on Windows. Omit if event is generated instead of collected via logs.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The event processed time, such as an ETL operation.
The list of profiles used to create the event. Profiles should be referenced by their name attribute for core profiles, or extension/name for profiles from extensions.
Sequence number of the event. The sequence number is a value available in some events, to make the exact ordering of events unambiguous, regardless of the event time precision.
SeverityId is an enum, and the following values are allowed. 0 - Unknown: The event/finding severity is unknown. 1 - Informational: Informational message. No action required. 2 - Low: The user decides if action is needed. 3 - Medium: Action is required but the situation is not serious at this time. 4 - High: Action is required immediately. 5 - Critical: Action is required immediately and the scope is broad. 6 - Fatal: An error occurred but it is too late to take remedial action. 99 - Other: The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
TypeUid is an enum, and the following values are allowed. 300100 - Unknown 300101 - Create: A user/role was created. 300102 - Enable: A user/role was enabled. 300103 - PasswordChange: An attempt was made to change an account's password. 300104 - PasswordReset: An attempt was made to reset an account's password. 300105 - Disable: A user/role was disabled. 300106 - Delete: A user/role was deleted. 300107 - AttachPolicy: An IAM Policy was attached to a user/role. 300108 - DetachPolicy: An IAM Policy was detached from a user/role. 300109 - Lock: A user account was locked out. 300110 - MFAFactorEnable: An authentication factor was enabled for an account. 300111 - MFAFactorDisable: An authentication factor was disabled for an account. 300199 - Other
The User object describes the characteristics of a user/person or a security principal. Defined by D3FEND d3f:UserAccount.
The Account object contains details about the account that initiated or performed a specific activity within a system or application.
The unique identifier of the user's credential. For example, AWS Access Key ID.
The domain where the user is defined. For example: the LDAP or Active Directory domain.
Email address. For example: john_doe@example.com.
The full name of the person, as per the LDAP Common Name attribute (cn).
The administrative groups to which the user belongs.
The additional LDAP attributes that describe a person.
The multi-factor authentication status, normalized to the caption of the mfa_status_id value. In the case of 'Other', it is defined by the data source.
UserMfaStatusId is an enum, and the following values are allowed. 0 - Unknown: The status is unknown. 1 - Enabled: Multi-factor authentication is on for this user. 2 - NotEnabled: TMulti-factor authentication is off for this user. 99 - Other: The event status is not mapped. See the user_status attribute, which contains a data source specific value.
The Organization object describes characteristics of an organization or company and its division if any.
The risk level, normalized to the caption of the risk_level_id value.
UserRiskLevelId is an enum, and the following values are allowed. 0 - Info 1 - Low 2 - Medium 3 - High 4 - Critical 99 - Other: The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.
UserTypeId is an enum, and the following values are allowed. 0 - Unknown: The type is unknown. 1 - User: Regular user account. 2 - Admin: Admin/root user account. 3 - System: System account. For example, Windows computer accounts with a trailing dollar sign ($). 99 - Other: The type is not mapped. See the type attribute, which contains a data source specific value.
The unique user identifier. For example, the Windows user SID, ActiveDirectory DN or AWS user ARN.
The alternate user identifier. For example, the Active Directory user GUID or AWS user Principal ID.
The user status, normalized to the caption of the user_status_id value. In the case of 'Other', it is defined by the data source.
UserUserStatusId is an enum, and the following values are allowed. 0 - Unknown: The status is unknown. 1 - Active: The user is active. 2 - Pending: The user is not active, pending either user or admin action. 3 - Locked: The user account is locked requiring either time or intervention to unlock. 4 - Suspended: The user account is suspended. 5 - Deprovisioned: The user account has been deprovisioned and is pending removal. 99 - Other: The event status is not mapped. See the user_status attribute, which contains a data source specific value.
The Actor object contains details about the user, role, application, service, or process that initiated or performed a specific activity.
The API, or Application Programming Interface, object represents information pertaining to an API request and response.
The event category name, as defined by category_uid value: Identity & Access Management.
The Cloud object contains information about a cloud account such as AWS Account ID, regions, etc.
The number of times that events in the same logical group occurred during the event Start Time to End Time period.
An unordered collection of attributes. It defines a set of attributes available in all objects. It can be also used as a generic object to log objects that are not otherwise defined by the schema.
The Device object represents an addressable computer system or host, which is typically connected to a computer network and participates in the transmission or processing of data within the computer network. Defined by D3FEND d3f:Host.
The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The end time of a time period, or the time of the most recent event included in the aggregate event.
The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:
[{"name": "answers.ip", "value": "92.24.47.250", "type": "location", "data": {"city": "Socotra", "continent": "Asia", "coordinates": [-25.4153, 17.0743], "country": "YE", "desc": "Yemen"}}]The HTTP Request object represents the attributes of a request made to a web server. It encapsulates the details and metadata associated with an HTTP request, including the request method, headers, URL, query parameters, body content, and other relevant information.
The observables associated with the event or a finding.
The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.
The Policy object describes the policies that are applicable.
Policy attributes provide traceability to the operational state of the security product at the time that the event was captured, facilitating forensics, troubleshooting, and policy tuning/adjustments.
The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.
The Network Endpoint object describes characteristics of a network endpoint. These can be a source or destination of a network connection.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The start time of a time period, or the time of the least recent event included in the aggregate event.
The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.
The event status code, as reported by the event source.
For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.
The status detail contains additional information about the event/finding outcome.
StatusId is an enum, and the following values are allowed. 0 - Unknown: The status is unknown. 1 - Success 2 - Failure 99 - Other: The event status is not mapped. See the status attribute, which contains a data source specific value.
The normalized event occurrence time or the finding creation time.
The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.
An unordered collection of attributes. It defines a set of attributes available in all objects. It can be also used as a generic object to log objects that are not otherwise defined by the schema.
The User object describes the characteristics of a user/person or a security principal. Defined by D3FEND d3f:UserAccount.
{ "result": [ { … } ], "cursor": "string", "meta": { "stats": { … }, "api": { … } } }
Add metadata to the response by invoking meta functions. Documentation for meta functions is available at https://docs.synqly.com/api-reference/meta-functions. Not all meta function are available at every endpoint.
Select a field to order the results by. Defaults to name. To control the direction of the sorting, append [asc] or [desc] to the field name. For example, name[asc] will sort the results by name in ascending order. The ordering defaults to asc if not specified.
Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.
curl -i -X GET \
'https://api.synqly.com/v1/edr/iocs?cursor=string&filter=string&include_raw_data=true&limit=0&meta=string&order=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'List of iocs that match the query.
The time from which this Indicator is considered a valid indicator of the behaviors it is related or represents.
The created property represents the time at which the object was originally created.
The modified property is only used by STIX Objects that support versioning and represents the time that this particular version of the object was last modified.
A description that provides more details and context about the Indicator, potentially including its purpose and its key characteristics.
A set of categorizations for this indicator.
The detection pattern for this Indicator MAY be expressed as a STIX Pattern as specified in section 9 or another appropriate language such as SNORT, YARA, etc.
covers common pattern languages
The version of the pattern expression used in the pattern property.
The time at which this Indicator is no longer considered valid.
The kill chain phase to which this Indicator corresponds.
The revoked property indicates whether this object has been revoked. If the revoked property is present and set to true, then the object has been revoked.
The labels property is an array of strings that are used to categorize this object.
The confidence property is an integer from 0 to 100 that represents the confidence that this object is accurate and valid.
The lang property specifies the language used in the properties of the object.
The external_references property is an array of external references that are relevant to this object.
The object_marking_refs property is an array of ids of marking_definition objects that apply to this object.
The granular_markings property is an array of granular markings that are applied to this object.
{ "result": [ { … } ], "cursor": "string", "meta": { "stats": { … }, "api": { … } } }
The list of iocs to create
The time from which this Indicator is considered a valid indicator of the behaviors it is related or represents.
The created property represents the time at which the object was originally created.
The modified property is only used by STIX Objects that support versioning and represents the time that this particular version of the object was last modified.
A description that provides more details and context about the Indicator, potentially including its purpose and its key characteristics.
A set of categorizations for this indicator.
The detection pattern for this Indicator MAY be expressed as a STIX Pattern as specified in section 9 or another appropriate language such as SNORT, YARA, etc.
covers common pattern languages
The version of the pattern expression used in the pattern property.
The time at which this Indicator is no longer considered valid.
The kill chain phase to which this Indicator corresponds.
The revoked property indicates whether this object has been revoked. If the revoked property is present and set to true, then the object has been revoked.
The labels property is an array of strings that are used to categorize this object.
The confidence property is an integer from 0 to 100 that represents the confidence that this object is accurate and valid.
The lang property specifies the language used in the properties of the object.
The external_references property is an array of external references that are relevant to this object.
The object_marking_refs property is an array of ids of marking_definition objects that apply to this object.
The granular_markings property is an array of granular markings that are applied to this object.
curl -i -X POST \
https://api.synqly.com/v1/edr/iocs \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"indicators": [
{
"type": "indicator",
"name": "string",
"description": "string",
"indicator_types": [
"anomalous_activity"
],
"pattern": "string",
"pattern_type": "stix",
"pattern_version": "string",
"valid_from": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"kill_chain_phases": [
{
"kill_chain_name": "string",
"phase_name": "string"
}
],
"raw_data": "string",
"spec_version": "2.1",
"id": "string",
"created_by_ref": {
"type": "string",
"name": "string",
"description": "string",
"roles": "string",
"identity_class": "individual"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"revoked": true,
"labels": [
"string"
],
"confidence": 0,
"lang": "string",
"external_references": [
{
"source_name": "string",
"description": "string",
"url": "string",
"hash": "string",
"external_id": "string"
}
],
"object_marking_refs": [
{
"type": "string",
"name": "string"
}
],
"granular_markings": [
{
"lang": "string",
"marking_ref": {
"type": "string",
"name": "string"
},
"selectors": [
"string"
]
}
],
"extensions": {}
}
]
}'A list of the indicators that were created
The time from which this Indicator is considered a valid indicator of the behaviors it is related or represents.
The created property represents the time at which the object was originally created.
The modified property is only used by STIX Objects that support versioning and represents the time that this particular version of the object was last modified.
A description that provides more details and context about the Indicator, potentially including its purpose and its key characteristics.
A set of categorizations for this indicator.
The detection pattern for this Indicator MAY be expressed as a STIX Pattern as specified in section 9 or another appropriate language such as SNORT, YARA, etc.
covers common pattern languages
The version of the pattern expression used in the pattern property.
The time at which this Indicator is no longer considered valid.
The kill chain phase to which this Indicator corresponds.
The revoked property indicates whether this object has been revoked. If the revoked property is present and set to true, then the object has been revoked.
The labels property is an array of strings that are used to categorize this object.
The confidence property is an integer from 0 to 100 that represents the confidence that this object is accurate and valid.
The lang property specifies the language used in the properties of the object.
The external_references property is an array of external references that are relevant to this object.
The object_marking_refs property is an array of ids of marking_definition objects that apply to this object.
The granular_markings property is an array of granular markings that are applied to this object.
{ "result": [ { … } ], "meta": { "stats": { … }, "api": { … } } }
curl -i -X DELETE \
'https://api.synqly.com/v1/edr/iocs?ids=string&meta=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "result": [ "string" ], "meta": { "stats": { … }, "api": { … } } }
Add metadata to the response by invoking meta functions. Documentation for meta functions is available at https://docs.synqly.com/api-reference/meta-functions. Not all meta function are available at every endpoint.
Select a field to order the results by. Defaults to name. To control the direction of the sorting, append [asc] or [desc] to the field name. For example, name[asc] will sort the results by name in ascending order. The ordering defaults to asc if not specified.
Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.
curl -i -X GET \
'https://api.synqly.com/v1/edr/posture_score?cursor=string&filter=string&include_raw_data=true&limit=0&meta=string&order=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'List of posture scores that match the query.
ActivityId is an enum, and the following values are allowed. 0 - Unknown: The event activity is unknown. 1 - Log: The discovered information is via a log. 2 - Collect: The discovered information is via a collection process. 99 - Other: The event activity is not mapped. See the activity_name attribute, which contains a data source specific value.
CategoryUid is an enum, and the following values are allowed. 5 - Discovery: Discovery events report the existence and state of devices, files, configurations, processes, registry keys, and other objects.
ClassUid is an enum, and the following values are allowed. 5002 - DeviceConfigState: Device Config State events report device configuration data and CIS Benchmark results.
The Device object represents an addressable computer system or host, which is typically connected to a computer network and participates in the transmission or processing of data within the computer network. Defined by D3FEND d3f:Host.
DeviceTypeId is an enum, and the following values are allowed. 0 - Unknown: The type is unknown. 1 - Server: A server. 2 - Desktop: A desktop computer. 3 - Laptop: A laptop computer. 4 - Tablet: A tablet computer. 5 - Mobile: A mobile phone. 6 - Virtual: A virtual machine. 7 - IOT: An IOT (Internet of Things) device. 8 - Browser: A web browser. 9 - Firewall: A networking firewall. 10 - Switch: A networking switch. 11 - Hub: A networking hub. 12 - Router: A networking router. 13 - IDS: An intrusion detection system. 14 - IPS: An intrusion prevention system. 15 - LoadBalancer: A Load Balancer device. 89 - ImagingEquipment: Equipment for processing optical data, such as a camera. 90 - PLC: A Programmable logic controller. 91 - SCADA: A supervisory control and data acquisition system. 92 - DCS: A distributed control system. 93 - CNC: A computer numerical control system, including computerized machine tools. 94 - ScientificEquipment: A piece of scientific equipment such as an oscilloscope or spectrometer. 95 - MedicalDevice: A medical device such as an MRI machine or infusion pump. 96 - LightingControls: A lighting control for internal or external applications. 97 - EnergyMonitoringSystem: An energy monitoring, security or safety system. 98 - TransportationDevice: A transportation device or transportation supporting device. 99 - Other: The type is not mapped. See the type attribute, which contains a data source specific value.
A list of agent objects associated with a device, endpoint, or resource.
The unique identifier of the cloud autoscale configuration.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The Container object describes an instance of a specific container. A container is a prepackaged, portable system image that runs isolated on an existing system using a container runtime like containerd.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the device was known to have been created.
The description of the device, ordinarily as reported by the operating system.
The network domain where the device resides. For example: work.example.com.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The initial discovery time of the device.
The group names to which the device belongs. For example: ["Windows Laptops", "Engineering"].
Unique name assigned to a device connected to a computer network. A domain name in general is an Internet address that can be resolved through the Domain Name System (DNS). For example: r2-d2.example.com.
The Device Hardware Information object contains details and specifications of the physical components that make up a device. This information provides an overview of the hardware capabilities, configuration, and characteristics of the device.
The name of the hypervisor running on the device. For example, Xen, VMware, Hyper-V, VirtualBox, etc.
The Image object provides a description of a specific Virtual Machine (VM) or Container image. Defined by D3FEND d3f:ContainerImage.
The International Mobile Station Equipment Identifier that is associated with the device.
Internet Protocol address (IP address), in either IPv4 or IPv6 format. For example, 192.168.200.24 or 2001:0db8:85a3:0000:0000:8a2e:0370:7334.
A list of IP addresses available on the device
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The most recent discovery time of the device.
The Geo Location object describes a geographical location, usually associated with an IP address. Defined by D3FEND d3f:PhysicalLocation.
Media Access Control (MAC) address. For example: 18:36:F3:98:4F:9A.
A list of MAC addresses available on the device
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the device was last known to have been modified.
The alternate device name, ordinarily as assigned by an administrator.
Note: The Name could be any other string that helps to identify the device, such as a phone number; for example 310-555-1234.
If running under a process namespace (such as in a container), the process identifier within that process namespace.
A list of NetBIOS names available on the device
The network interfaces that are associated with the device, one for each unique MAC address/IP address/hostname/name combination.
Note: The first element of the array is the network information that pertains to the event.
DeviceNetworkStatusId is an enum, and the following values are allowed. 1 - NotIsolated: Device is not isolated from the network. 2 - Isolated: Device is isolated from the network. 99 - Unknown: The network isolation status is unknown.
The Organization object describes characteristics of an organization or company and its division if any.
The Operating System (OS) object describes characteristics of an OS, such as Linux or Windows. Defined by D3FEND d3f:OperatingSystem.
The User object describes the characteristics of a user/person or a security principal. Defined by D3FEND d3f:UserAccount.
The region where the virtual machine is located. For example, an AWS Region.
The risk level, normalized to the caption of the risk_level_id value.
DeviceRiskLevelId is an enum, and the following values are allowed. 0 - Info 1 - Low 2 - Medium 3 - High 4 - Critical 99 - Other: The risk level is not mapped. See the risk_level attribute, which contains a data source specific value.
The subnet represented in a CIDR notation, using the format network_address/prefix_length. The network_address can be in either IPv4 or IPv6 format. The prefix length indicates the number of bits used for the network portion, and the remaining bits are available for host addresses within that subnet.
The list of software contained on a device
The device type. For example: unknown, server, desktop, laptop, tablet, mobile, virtual, browser, plc, scada, dcs, cnc, scientific, medical, lighting, energy, transportation other.
The unique identifier of the device. For example the Windows TargetSID or AWS EC2 ARN.
An alternate unique identifier of the device if any. For example the ActiveDirectory DN.
The Organization object describes characteristics of an organization or company and its division if any.
The Metadata object describes the metadata associated with the event. Defined by D3FEND d3f:Metadata.
The Product object describes characteristics of a software product.
The Common Platform Enumeration (CPE) name as described by (NIST) For example: cpe:/a:apple:safari:16.2.
The Feature object provides information about the software product feature that generated a specific event. It encompasses details related to the capabilities, components, user interface (UI) design, and performance upgrades associated with the feature.
The two letter lower case language codes, as defined by ISO 639-1. For example: en (English), de (German), or fr (French).
Uniform Resource Locator (URL) string. For example: http://www.example.com/download/trouble.exe.
The version of the OCSF schema, using Semantic Versioning Specification (SemVer). For example: 1.0.0. Event consumers use the version to determine the available event attributes.
The Event ID or Code that the product uses to describe the event.
The OCSF Schema Extension object provides detailed information about the schema extension used to construct the event. The schema extensions are registered in the extensions.md file.
The schema extensions used to create the event.
The list of category labels attached to the event or specific attributes. Labels are user defined tags or aliases added at normalization time.
For example:["network", "connection.ip:destination", "device.ip:source"]The event log name. For example, syslog file name or Windows logging subsystem: Security.
The logging provider or logging service that logged the event. For example, Microsoft-Windows-Security-Auditing.
The event log schema version that specifies the format of the original event. For example syslog version or Cisco Log Schema Version.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the logging system collected and logged the event.
This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.An array of Logger objects that describe the devices and logging products between the event source and its eventual destination. Note, this attribute can be used when there is a complex end-to-end path of event flow.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The time when the event was last modified or enriched.
The original event time as reported by the event source. For example, the time in the original format from system event log such as Syslog on Unix/Linux and the System event file on Windows. Omit if event is generated instead of collected via logs.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The event processed time, such as an ETL operation.
The list of profiles used to create the event. Profiles should be referenced by their name attribute for core profiles, or extension/name for profiles from extensions.
Sequence number of the event. The sequence number is a value available in some events, to make the exact ordering of events unambiguous, regardless of the event time precision.
SeverityId is an enum, and the following values are allowed. 0 - Unknown: The event/finding severity is unknown. 1 - Informational: Informational message. No action required. 2 - Low: The user decides if action is needed. 3 - Medium: Action is required but the situation is not serious at this time. 4 - High: Action is required immediately. 5 - Critical: Action is required immediately and the scope is broad. 6 - Fatal: An error occurred but it is too late to take remedial action. 99 - Other: The event/finding severity is not mapped. See the severity attribute, which contains a data source specific value.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
TypeUid is an enum, and the following values are allowed. 500200 - Unknown 500201 - Log: The discovered information is via a log. 500202 - Collect: The discovered information is via a collection process. 500299 - Other
The Actor object contains details about the user, role, application, service, or process that initiated or performed a specific activity.
The API, or Application Programming Interface, object represents information pertaining to an API request and response.
The event category name, as defined by category_uid value: Discovery.
The CIS Benchmark Result object contains information as defined by the Center for Internet Security (CIS) benchmark result. CIS Benchmarks are a collection of best practices for securely configuring IT systems, software, networks, and cloud infrastructure.
The Cloud object contains information about a cloud account such as AWS Account ID, regions, etc.
The number of times that events in the same logical group occurred during the event Start Time to End Time period.
An unordered collection of attributes. It defines a set of attributes available in all objects. It can be also used as a generic object to log objects that are not otherwise defined by the schema.
The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The end time of a time period, or the time of the most recent event included in the aggregate event.
The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:
[{"name": "answers.ip", "value": "92.24.47.250", "type": "location", "data": {"city": "Socotra", "continent": "Asia", "coordinates": [-25.4153, 17.0743], "country": "YE", "desc": "Yemen"}}]The observables associated with the event or a finding.
The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.
The event/finding severity, normalized to the caption of the severity_id value. In the case of 'Other', it is defined by the source.
The timestamp format is the number of milliseconds since the Epoch 01/01/1970 00:00:00 UTC. For example 1618524549901.
The start time of a time period, or the time of the least recent event included in the aggregate event.
The event status, normalized to the caption of the status_id value. In the case of 'Other', it is defined by the event source.
The event status code, as reported by the event source.
For example, in a Windows Failed Authentication event, this would be the value of 'Failure Code', e.g. 0x18.
The status detail contains additional information about the event/finding outcome.
StatusId is an enum, and the following values are allowed. 0 - Unknown: The status is unknown. 1 - Success 2 - Failure 99 - Other: The event status is not mapped. See the status attribute, which contains a data source specific value.
The normalized event occurrence time or the finding creation time.
The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.
{ "result": [ { … } ], "cursor": "string", "meta": { "stats": { … }, "api": { … } } }