List indicators
Relative path: /v3/indicators
Returns a list of all the [indicator]s matching the criteria.
Endpoint URL for Europe, Germany, United States, Canada and Japan regions:
|
https://eu.incident-management.eset.systems/v3/indicators |
|
https://de.incident-management.eset.systems/v3/indicators |
|
https://us.incident-management.eset.systems/v3/indicators |
|
https://ca.incident-management.eset.systems/v3/indicators |
|
https://jpn.incident-management.eset.systems/v3/indicators |
Query parameters
Name |
Type |
Description |
|---|---|---|
endTime |
string |
Include only indicators occurred before
Use a timestamp in UTC or offset format. Examples: - 2024-10-30T12:00Z - 2024-10-30T10:00+02:00 |
startTime |
string |
Include only indicators occurred after
Use a timestamp in UTC or offset format. Examples: - 2024-10-30T12:00Z - 2024-10-30T10:00+02:00 |
view |
string |
Determines the view of the indicator that should appear in the response. If null or empty, it defaults to BASIC. •INDICATOR_VIEW_UNSPECIFIED: fallback •INDICATOR_VIEW_BASIC: Only basic indicator fields (i.e. those derived from ECS.base). •INDICATOR_VIEW_FULL: All the fields of the incident indicator. |
pageSize |
integer |
Limit for pagination purposes. If unspecified or 0, the default value is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string |
Page token of the current page. If not given or "", the first page is returned. The page token also captures filtering criteria, so there is no need to pass them in subsequent page requests. If client passes them together with page token, they will be ignored anyway.
|
Responses
Code |
Description and Example |
Description, Schema and Headers |
|---|---|---|
200 |
Successful response.
{
"indicators": [
{
"azure": {
"@type": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"eset": {
"@type": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"paloalto": {
"@type": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"ownerUuid": "string",
"uuid": "string",
"agent": {
"build": {
"original": "string"
},
"ephemeral_id": "string",
"name": "string",
"type": "string",
"version": "string",
"id": "string"
},
"cloud": {
"account": {
"id": "string",
"name": "string"
},
"availability_zone": "string",
"instance": {
"id": "string",
"name": "string"
},
"machine": {
"type": "string"
},
"project": {
"id": "string",
"name": "string"
},
"provider": "string",
"region": "string",
"service": {
"name": "string"
}
},
"destination": {
"address": "string",
"domain": "string",
"ip": "string",
"mac": "string",
"port": "string",
"registered_domain": "string",
"subdomain": "string",
"top_level_domain": "string",
"geo": {
"city_name": "string",
"continent_code": "string",
"continent_name": "string",
"country_iso_code": "string",
"country_name": "string",
"location": "string",
"name": "string",
"postal_code": "string",
"region_iso_code": "string",
"region_name": "string",
"timezone": "string"
},
"as": {
"number": "string",
"organization": {
"name": "string"
}
},
"nat": {
"ip": "string",
"port": "string"
},
"user": {
"domain": "string",
"email": "string",
"id": "string",
"name": "string",
"full_name": "string"
}
},
"device": {
"id": "string",
"manufacturer": "string",
"model": {
"identifier": "string",
"name": "string"
},
"serial_number": "string"
},
"dll": {
"name": "string",
"path": "string",
"hash": {
"md5": "string",
"sha1": "string",
"sha256": "string"
},
"pe": {
"architecture": "string",
"company": "string",
"description": "string",
"file_version": "string",
"original_file_name": "string",
"product": "string"
},
"code_signature": {
"exists": true,
"status": "string",
"subject_name": "string",
"digest_algorithm": "string",
"signing_id": "string",
"team_id": "string",
"timestamp": "string",
"trusted": true,
"valid": true,
"thumbprint_sha1": "string"
}
},
"ecs": {
"version": "string"
},
"email": {
"attachments": [
{
"file": {
"extension": "string",
"mime_type": "string",
"name": "string",
"size": "string",
"hash": {
"md5": "string",
"sha1": "string",
"sha256": "string"
}
}
}
],
"bcc": [
{
"address": "string"
}
],
"cc": [
{
"address": "string"
}
],
"content_type": "string",
"delivery_timestamp": "string",
"direction": "string",
"from": [
{
"address": "string"
}
],
"local_id": "string",
"message_id": "string",
"origination_timestamp": "string",
"reply_to": [
{
"address": "string"
}
],
"sender": [
{
"address": "string"
}
],
"subject": "string",
"to": [
{
"address": "string"
}
],
"x_mailer": "string"
},
"event": {
"action": "string",
"category": [
"string"
],
"created": "string",
"dataset": "string",
"id": "string",
"ingested": "string",
"kind": "string",
"module": "string",
"outcome": "string",
"provider": "string",
"reason": "string",
"risk_score": 0,
"severity": "string",
"type": [
"string"
]
},
"file": {
"accessed": "string",
"attributes": [
"string"
],
"created": "string",
"ctime": "string",
"device": "string",
"directory": "string",
"drive_letter": "string",
"extension": "string",
"fork_name": "string",
"gid": "string",
"group": "string",
"inode": "string",
"mime_type": "string",
"mode": "string",
"mtime": "string",
"name": "string",
"owner": "string",
"path": "string",
"size": "string",
"target_path": "string",
"type": "string",
"uid": "string",
"code_signature": {
"exists": true,
"status": "string",
"subject_name": "string",
"digest_algorithm": "string",
"signing_id": "string",
"team_id": "string",
"timestamp": "string",
"trusted": true,
"valid": true,
"thumbprint_sha1": "string"
},
"hash": {
"md5": "string",
"sha1": "string",
"sha256": "string"
},
"pe": {
"architecture": "string",
"company": "string",
"description": "string",
"file_version": "string",
"original_file_name": "string",
"product": "string"
}
},
"host": {
"architecture": "string",
"domain": "string",
"hostname": "string",
"id": "string",
"ip": [
"string"
],
"mac": [
"string"
],
"name": "string",
"type": "string",
"os": {
"name": "string",
"type": "string",
"version": "string"
},
"geo": {
"city_name": "string",
"continent_code": "string",
"continent_name": "string",
"country_iso_code": "string",
"country_name": "string",
"location": "string",
"name": "string",
"postal_code": "string",
"region_iso_code": "string",
"region_name": "string",
"timezone": "string"
}
},
"network": {
"application": "string",
"community_id": "string",
"direction": "string",
"forwarded_ip": "string",
"iana_number": "string",
"name": "string",
"protocol": "string",
"transport": "string",
"type": "string"
},
"observer": {
"egress": {
"zone": "string"
},
"hostname": "string",
"ingress": {
"zone": "string"
},
"ip": [
"string"
],
"mac": [
"string"
],
"name": "string",
"product": "string",
"serial_number": "string",
"type": "string",
"vendor": "string",
"version": "string",
"geo": {
"city_name": "string",
"continent_code": "string",
"continent_name": "string",
"country_iso_code": "string",
"country_name": "string",
"location": "string",
"name": "string",
"postal_code": "string",
"region_iso_code": "string",
"region_name": "string",
"timezone": "string"
}
},
"process": {
"args": [
"string"
],
"args_count": "string",
"command_line": "string",
"end": "string",
"entity_id": "string",
"executable": "string",
"name": "string",
"pid": "string",
"start": "string",
"code_signature": {
"exists": true,
"status": "string",
"subject_name": "string",
"digest_algorithm": "string",
"signing_id": "string",
"team_id": "string",
"timestamp": "string",
"trusted": true,
"valid": true,
"thumbprint_sha1": "string"
},
"hash": {
"md5": "string",
"sha1": "string",
"sha256": "string"
},
"parent": {
"args": [
"string"
],
"args_count": "string",
"command_line": "string",
"entity_id": "string",
"executable": "string",
"name": "string",
"pid": "string",
"start": "string",
"code_signature": {
"exists": true,
"status": "string",
"subject_name": "string",
"digest_algorithm": "string",
"signing_id": "string",
"team_id": "string",
"timestamp": "string",
"trusted": true,
"valid": true,
"thumbprint_sha1": "string"
},
"hash": {
"md5": "string",
"sha1": "string",
"sha256": "string"
},
"group_leader": {
"entity_id": "string",
"pid": "string",
"start": "string"
},
"responsible": {
"entity_id": "string",
"pid": "string",
"start": "string"
},
"interactive": true
},
"pe": {
"architecture": "string",
"company": "string",
"description": "string",
"file_version": "string",
"original_file_name": "string",
"product": "string"
},
"user": {
"domain": "string",
"email": "string",
"id": "string",
"name": "string",
"full_name": "string",
"target": {
"domain": "string",
"id": "string",
"name": "string",
"full_name": "string"
},
"group": {
"domain": "string",
"id": "string",
"name": "string"
},
"changes": {
"domain": "string",
"id": "string",
"name": "string",
"full_name": "string"
}
},
"group": {
"domain": "string",
"id": "string",
"name": "string"
},
"group_leader": {
"args": [
"string"
],
"args_count": "string",
"command_line": "string",
"entity_id": "string",
"executable": "string",
"name": "string",
"pid": "string",
"start": "string",
"code_signature": {
"exists": true,
"status": "string",
"subject_name": "string",
"digest_algorithm": "string",
"signing_id": "string",
"team_id": "string",
"timestamp": "string",
"trusted": true,
"valid": true,
"thumbprint_sha1": "string"
},
"hash": {
"md5": "string",
"sha1": "string",
"sha256": "string"
},
"interactive": true
},
"responsible": {
"args": [
"string"
],
"args_count": "string",
"command_line": "string",
"entity_id": "string",
"executable": "string",
"name": "string",
"pid": "string",
"start": "string",
"code_signature": {
"exists": true,
"status": "string",
"subject_name": "string",
"digest_algorithm": "string",
"signing_id": "string",
"team_id": "string",
"timestamp": "string",
"trusted": true,
"valid": true,
"thumbprint_sha1": "string"
},
"hash": {
"md5": "string",
"sha1": "string",
"sha256": "string"
},
"interactive": true
},
"interactive": true
},
"registry": {
"hive": "string",
"key": "string",
"path": "string",
"value": "string",
"data": {
"bytes": "string",
"strings": [
"string"
],
"type": "string"
}
},
"related": {
"hash": [
"string"
],
"hosts": [
"string"
],
"ip": [
"string"
],
"user": [
"string"
]
},
"source": {
"address": "string",
"domain": "string",
"ip": "string",
"mac": "string",
"port": "string",
"registered_domain": "string",
"subdomain": "string",
"top_level_domain": "string",
"geo": {
"city_name": "string",
"continent_code": "string",
"continent_name": "string",
"country_iso_code": "string",
"country_name": "string",
"location": "string",
"name": "string",
"postal_code": "string",
"region_iso_code": "string",
"region_name": "string",
"timezone": "string"
},
"as": {
"number": "string",
"organization": {
"name": "string"
}
},
"nat": {
"ip": "string",
"port": "string"
},
"user": {
"domain": "string",
"email": "string",
"id": "string",
"name": "string",
"full_name": "string"
}
},
"@timestamp": "string",
"threat": {
"enrichments": [
{
"indicator": {
"confidence": "string",
"description": "string",
"email": {
"address": "string"
},
"first_seen": "string",
"id": [
"string"
],
"ip": "string",
"last_seen": "string",
"marking": {
"tlp": "string",
"tlp_version": "string"
},
"modified_at": "string",
"name": "string",
"port": "string",
"provider": "string",
"reference": "string",
"scanner_stats": "string",
"sightings": "string",
"type": "string",
"geo": {
"city_name": "string",
"continent_code": "string",
"continent_name": "string",
"country_iso_code": "string",
"country_name": "string",
"location": "string",
"name": "string",
"postal_code": "string",
"region_iso_code": "string",
"region_name": "string",
"timezone": "string"
},
"as": {
"number": "string",
"organization": {
"name": "string"
}
}
},
"matched": {
"atomic": "string",
"field": "string",
"id": "string",
"index": "string",
"occurred": "string",
"type": "string"
}
}
],
"feed": {
"dashboard_id": "string",
"description": "string",
"name": "string",
"reference": "string"
},
"framework": "string",
"group": {
"alias": [
"string"
],
"id": "string",
"name": "string",
"reference": "string"
},
"indicator": {
"confidence": "string",
"description": "string",
"email": {
"address": "string"
},
"first_seen": "string",
"id": [
"string"
],
"ip": "string",
"last_seen": "string",
"marking": {
"tlp": "string",
"tlp_version": "string"
},
"modified_at": "string",
"name": "string",
"port": "string",
"provider": "string",
"reference": "string",
"scanner_stats": "string",
"sightings": "string",
"type": "string",
"geo": {
"city_name": "string",
"continent_code": "string",
"continent_name": "string",
"country_iso_code": "string",
"country_name": "string",
"location": "string",
"name": "string",
"postal_code": "string",
"region_iso_code": "string",
"region_name": "string",
"timezone": "string"
},
"as": {
"number": "string",
"organization": {
"name": "string"
}
}
},
"software": {
"id": "string",
"name": "string",
"platforms": [
"string"
],
"reference": "string",
"type": "string"
},
"tactic": {
"id": [
"string"
],
"name": [
"string"
],
"reference": [
"string"
]
},
"technique": {
"id": [
"string"
],
"name": [
"string"
],
"reference": [
"string"
],
"subtechnique": [
{
"id": [
"string"
],
"name": [
"string"
],
"reference": [
"string"
]
}
]
}
},
"rule": {
"author": [
"string"
],
"category": "string",
"description": "string",
"id": "string",
"license": "string",
"name": "string",
"reference": "string",
"ruleset": "string",
"version": "string",
"uuid": "string"
},
"url": {
"domain": "string",
"extension": "string",
"fragment": "string",
"full": "string",
"original": "string",
"password": "string",
"path": "string",
"port": "string",
"query": "string",
"registered_domain": "string",
"scheme": "string",
"subdomain": "string",
"top_level_domain": "string",
"username": "string"
},
"user": {
"domain": "string",
"email": "string",
"id": "string",
"name": "string",
"full_name": "string",
"target": {
"domain": "string",
"id": "string",
"name": "string",
"full_name": "string"
},
"group": {
"domain": "string",
"id": "string",
"name": "string"
},
"changes": {
"domain": "string",
"id": "string",
"name": "string",
"full_name": "string"
}
},
"user_agent": {
"name": "string",
"original": "string",
"version": "string",
"device": {
"name": "string"
}
},
"volume": {
"bus_type": "string",
"default_access": "string",
"device_name": "string",
"device_type": "string",
"dos_name": "string",
"file_system_type": "string",
"mount_name": "string",
"nt_name": "string",
"product_id": "string",
"product_name": "string",
"removable": true,
"serial_number": "string",
"size": "string",
"vendor_id": "string",
"vendor_name": "string",
"writable": true
}
}
],
"nextPageToken": "string"
}
|
Successful response.
{
"$ref": "v3ListIndicatorsResponse",
"indicators": [
{
"$ref": "incident_managementv3Indicator",
"description": "An (incident) indicator is a sign that an incident may have occurred or may be occurring now. Indicator entity provides common ground for all the signals to be processed in unified manner no matter of the source. Details can be found in signal attribute of variant type. NIST 800-61rev2 says: Too many types of indicators exist to exhaustively list them, but some examples are listed below: - A network intrusion detection sensor alerts when a buffer overflow attempt occurs against a database server. - Antivirus software alerts when it detects that a host is infected with malware. - A system administrator sees a filename with unusual characters. - A host records an auditing configuration change in its log. - An application logs multiple failed login attempts from an unfamiliar remote system. - An email administrator sees a large number of bounced emails with suspicious content. - A network administrator notices an unusual deviation from typical network traffic flows.",
"azure": {
"$ref": "protobufAny",
"description": "Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field. Protobuf APIs provide utilities to interact with Any values: A 'pack' operation accepts a message and constructs a generic Any wrapper around it. An 'unpack' operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url. An 'is' operation decides whether an Any contains a message of the given type, i.e. whether it can 'unpack' that type. The JSON format representation of an Any follows one of these cases: For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL. For types with special-cased JSON encodings (typically called 'well-known' types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value. The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.",
"@type": {
"type": "string",
"description": "Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name. Example: type.googleapis.com/google.protobuf.StringValue This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them. The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests. All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected. In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs."
},
"additionalProperties": {
"type": "object"
}
},
"eset": {
"$ref": "protobufAny",
"description": "Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field. Protobuf APIs provide utilities to interact with Any values: A 'pack' operation accepts a message and constructs a generic Any wrapper around it. An 'unpack' operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url. An 'is' operation decides whether an Any contains a message of the given type, i.e. whether it can 'unpack' that type. The JSON format representation of an Any follows one of these cases: For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL. For types with special-cased JSON encodings (typically called 'well-known' types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value. The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.",
"@type": {
"type": "string",
"description": "Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name. Example: type.googleapis.com/google.protobuf.StringValue This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them. The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests. All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected. In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs."
},
"additionalProperties": {
"type": "object"
}
},
"paloalto": {
"$ref": "protobufAny",
"description": "Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field. Protobuf APIs provide utilities to interact with Any values: A 'pack' operation accepts a message and constructs a generic Any wrapper around it. An 'unpack' operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url. An 'is' operation decides whether an Any contains a message of the given type, i.e. whether it can 'unpack' that type. The JSON format representation of an Any follows one of these cases: For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL. For types with special-cased JSON encodings (typically called 'well-known' types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value. The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.",
"@type": {
"type": "string",
"description": "Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name. Example: type.googleapis.com/google.protobuf.StringValue This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them. The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests. All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected. In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs."
},
"additionalProperties": {
"type": "object"
}
},
"ownerUuid": {
"type": "string",
"description": "Identifier of the tenant who owns this object. type: tenant_management.v1.Tenant"
},
"uuid": {
"type": "string",
"description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within the entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 9562: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier, albeit of predictable length and alphabet. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'",
"readOnly": true
},
"agent": {
"$ref": "v8Agent",
"description": "Fields about the monitoring agent. The agent fields contain the data about the software entity, if any, that collects, detects, or observes events on a host, or takes measurements on a host. Examples include Beats. Agents may also run on observers. ECS agent.* fields shall be populated with details of the agent running on the host or observer where the event happened or the measurement was taken. Examples: In the case of Beats for logs, the agent.name is filebeat. For APM, it is the agent running in the app/service. The agent information does not change if data is sent through queuing systems like Kafka, Redis, or processing systems such as Logstash or APM Server.",
"build": {
"$ref": "AgentBuild",
"description": "Description of agent build.",
"original": {
"type": "string"
}
},
"ephemeral_id": {
"type": "string",
"description": "Ephemeral identifier of this agent. Ephemerally unique identifier of this agent (if one exists). This id normally changes across restarts, but agent.id does not. level: extended example: 8a4f500f"
},
"name": {
"type": "string",
"description": "Custom name of the agent. This is a name that can be given to an agent. This can be helpful if for example two Filebeat instances are running on the same host but a human readable separation is needed on which Filebeat instance data is coming from. level: core example: foo"
},
"type": {
"type": "string",
"description": "Type of the agent. The agent type always stays the same and should be given by the agent used. In case of Filebeat the agent would always be Filebeat also if two Filebeat instances are run on the same machine. level: core example: filebeat"
},
"version": {
"type": "string",
"description": "Version of the agent. level: core example: 6.0.0-rc2"
},
"id": {
"type": "string",
"description": "Unique identifier of this agent. Unique identifier of this agent (if one exists). For example: For Beats this would be beat.id. level: core example: 8a4f500d"
}
},
"cloud": {
"$ref": "v8Cloud",
"description": "Fields related to the cloud or infrastructure the events are coming from. Examples: If Metricbeat is running on an EC2 host and fetches data from its host, the cloud info contains the data about this machine. If Metricbeat runs on a remote machine outside the cloud and fetches data from a service running in the cloud, the field contains cloud data from the machine the service is running on. The cloud fields may be self-nested under cloud.origin.* and cloud.target.* to describe origin or target service's cloud information in the context of incoming or outgoing requests, respectively. However, the fieldsets cloud.origin.* and cloud.target.* must not be confused with the root cloud fieldset that is used to describe the cloud context of the actual service under observation. The fieldset cloud.origin.* may only be used in the context of incoming requests or events to provide the originating service's cloud information. The fieldset cloud.target.* may only be used in the context of outgoing requests or events to describe the target service's cloud information.",
"account": {
"$ref": "CloudAccount",
"description": "The cloud account or organization in a multi-tenant environment.",
"id": {
"type": "string",
"description": "The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. type: keyword example: 666777888999"
},
"name": {
"type": "string",
"description": "The cloud account name or alias used to identify different entities in a multi-tenant environment. Examples: AWS account name, Google Cloud ORG display name. type: keyword example: elastic-dev"
}
},
"availability_zone": {
"type": "string",
"description": "Availability zone in which this host, resource, or service is located. type: keyword example: us-east-1c"
},
"instance": {
"$ref": "CloudInstance",
"description": "Instance of the host machine.",
"id": {
"type": "string",
"description": "Instance ID of the host machine. type: keyword example: i-1234567890abcdef0"
},
"name": {
"title": "Instance name of the host machine. type: keyword",
"type": "string"
}
},
"machine": {
"$ref": "CloudMachine",
"description": "Details of the host machine.",
"type": {
"type": "string",
"description": "Machine type of the host machine. type: keyword example: t2.medium"
}
},
"project": {
"$ref": "CloudProject",
"description": "Cloud project properties.",
"id": {
"type": "string",
"description": "The cloud project identifier. Examples: Google Cloud Project id, Azure Project id. type: keyword example: my-project"
},
"name": {
"type": "string",
"description": "The cloud project name. Examples: Google Cloud Project name, Azure Project name. type: keyword example: my project"
}
},
"provider": {
"type": "string",
"description": "Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. type: keyword example: aws"
},
"region": {
"type": "string",
"description": "Region in which this host, resource, or service is located. type: keyword example: us-east-1"
},
"service": {
"$ref": "CloudService",
"description": "Distinguish between different cloud platform services.",
"name": {
"type": "string",
"description": "The cloud service name is intended to distinguish services running on different platforms within a provider, eg AWS EC2 vs Lambda, GCP GCE vs App Engine, Azure VM vs App Server. Examples: app engine, app service, cloud run, fargate, lambda. type: keyword example: lambda"
}
}
},
"destination": {
"$ref": "v8Destination",
"description": "Fields about the destination side of a network connection, used with source. Destination fields capture details about the receiver of a network exchange/packet. These fields are populated from a network event, packet, or other event containing details of a network transaction. Destination fields are usually populated in conjunction with source fields. The source and destination fields are considered the baseline and should always be filled if an event contains source and destination details from a network transaction. If the event also contains identification of the client and server roles, then the client and server fields should also be populated.",
"address": {
"type": "string",
"description": "Destination network address. Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the .address field. Then it should be duplicated to .ip or .domain, depending on which one it is. level: extended"
},
"domain": {
"type": "string",
"description": "The domain name of the destination system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. level: core example: foo.example.com"
},
"ip": {
"type": "string",
"description": "IP address of the destination. IP address of the destination (IPv4 or IPv6). level: core"
},
"mac": {
"type": "string",
"description": "MAC address of the destination. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. level: core pattern: ^[A-F0-9]{2}(-[A-F0-9]{2}){5,}$ example: 00-00-5E-00-53-23"
},
"port": {
"type": "string",
"description": "Port of the destination. level: core",
"format": "int64"
},
"registered_domain": {
"type": "string",
"description": "The highest registered destination domain, stripped of the subdomain. The highest registered destination domain, stripped of the subdomain. For example, the registered domain for 'foo.example.com' is 'example.com'. This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as 'co.uk'. level: extended example: example.com"
},
"subdomain": {
"type": "string",
"description": "The subdomain of the domain. The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of 'www.east.mydomain.co.uk' is 'east'. If the domain has multiple levels of subdomain, such as 'sub2.sub1.example.com', the subdomain field should contain 'sub2.sub1', with no trailing period. level: extended example: east"
},
"top_level_domain": {
"type": "string",
"description": "The effective top level domain (com, org, net, co.uk). The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is 'com'. This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as 'co.uk'. level: extended example: co.uk"
},
"geo": {
"$ref": "v8Geo",
"description": "Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied. Note also that the geo fields are not expected to be used directly at the root of the events.",
"city_name": {
"type": "string",
"description": "City name. level: core example: Montreal"
},
"continent_code": {
"type": "string",
"description": "Two-letter code representing continent's name. level: core example: NA"
},
"continent_name": {
"type": "string",
"description": "Name of the continent. level: core example: North America"
},
"country_iso_code": {
"type": "string",
"description": "Country ISO code. level: core example: CA"
},
"country_name": {
"type": "string",
"description": "Country name. level: core example: Canada"
},
"location": {
"type": "string",
"description": "Longitude and latitude. level: core example: { 'lon': -73.614830, 'lat': 45.505918 }"
},
"name": {
"type": "string",
"description": "User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. level: extended example: boston-dc"
},
"postal_code": {
"type": "string",
"description": "Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. level: core example: 94040"
},
"region_iso_code": {
"type": "string",
"description": "Region ISO code. level: core example: CA-QC"
},
"region_name": {
"type": "string",
"description": "Region name. level: core example: Quebec"
},
"timezone": {
"type": "string",
"description": "The time zone of the location, such as IANA time zone name. level: core example: America/Argentina/Buenos_Aires"
}
},
"as": {
"$ref": "v8As",
"description": "An autonomous system (AS) is a collection of connected Internet Protocol (IP) routing prefixes under the control of one or more network operators on behalf of a single administrative entity or domain that presents a common, clearly defined routing policy to the internet.",
"number": {
"type": "string",
"description": "Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. level: extended example: 15169",
"format": "int64"
},
"organization": {
"$ref": "AsOrganization",
"description": "Object containing information about the owner of autonomous system.",
"name": {
"type": "string",
"description": "Organization name. level: extended example: Google LLC"
}
}
},
"nat": {
"$ref": "v8DestinationNat",
"ip": {
"title": "Translated ip of destination based NAT sessions (e.g. internet to private DMZ)",
"type": "string",
"description": "Typically used with load balancers, firewalls, or routers. level: extended"
},
"port": {
"type": "string",
"description": "Port the source session is translated to by NAT Device. Typically used with load balancers, firewalls, or routers. level: extended",
"format": "int64"
}
},
"user": {
"$ref": "v8DestinationUserReference",
"description": "Fields to describe the source user relevant to the event.",
"domain": {
"type": "string",
"description": "Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"email": {
"type": "string",
"description": "User email address. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier of the user. level: core example: S-1-5-21-202424912787-2692429404-2351956786-1000"
},
"name": {
"type": "string",
"description": "Short name or login of the user. level: core example: a.einstein"
},
"full_name": {
"type": "string",
"description": "User’s full name, if available. level: core example: Albert Einstein"
}
}
},
"device": {
"$ref": "ecsv8Device",
"description": "Fields that describe a device instance and its characteristics. Data collected for applications and processes running on a (mobile) device can be enriched with these fields to describe the identity, type and other characteristics of the device. This field group definition is based on the Device namespace of the OpenTelemetry Semantic Conventions. These fields are in beta and are subject to change.",
"id": {
"type": "string",
"description": "The unique identifier of a device. The identifier must not change across application sessions but stay fixed for an instance of a (mobile) device. On iOS, this value must be equal to the vendor identifier (https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). On Android, this value must be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. For GDPR and data protection law reasons this identifier should not carry information that would allow to identify a user. level: extended example: 00000000-54b3-e7c7-0000-000046bffd97"
},
"manufacturer": {
"type": "string",
"description": "The vendor name of the device manufacturer. level: extended example: Samsung"
},
"model": {
"$ref": "DeviceModel",
"identifier": {
"type": "string",
"description": "The machine readable identifier of the device model. level: extended example: SM-G920F"
},
"name": {
"type": "string",
"description": "The human readable marketing name of the device model. level: extended example: Samsung Galaxy S6"
}
},
"serial_number": {
"type": "string",
"description": "The unique serial number serves as a distinct identifier for each device, aiding in inventory management and device authentication. level: core example: DJGAQS4CW5"
}
},
"dll": {
"$ref": "v8Dll",
"description": "These fields contain information about code libraries dynamically loaded into processes. Many operating systems refer to 'shared code libraries' with different names, but this field set refers to all of the following: - Dynamic-link library (.dll) commonly used on Windows - Shared Object (.so) commonly used on Unix-like operating systems - Dynamic library (.dylib) commonly used on macOS",
"name": {
"type": "string",
"description": "Name of the library. This generally maps to the name of the file on disk. level: core example: kernel32.dll"
},
"path": {
"type": "string",
"description": "Full file path of the library. level: extended example: 'C:\Windows\System32\kernel32.dll'"
},
"hash": {
"$ref": "v8Hash",
"description": "Hashes, usually file hashes. The hash fields represent different bitwise hash algorithms and their values. Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for other hashes by lowercasing the hash algorithm name and using underscore separators as appropriate (snake case, e.g. sha3_512). Note that this fieldset is used for common hashes that may be computed over a range of generic bytes. Entity-specific hashes such as ja3 or imphash are placed in the fieldsets to which they relate (tls and pe, respectively). expected presence: - file - process - dll - email.attachments.file",
"md5": {
"type": "string",
"description": "MD5 hash. level: extended"
},
"sha1": {
"type": "string",
"description": "SHA1 hash. level: extended"
},
"sha256": {
"type": "string",
"description": "SHA256 hash. level: extended"
}
},
"pe": {
"$ref": "v8Pe",
"description": {
"type": "string",
"description": "Internal description of the file, provided at compile-time. level: extended example: 'Paint'"
},
"architecture": {
"type": "string",
"description": "CPU architecture target for the file. level: extended example: 'x64'"
},
"company": {
"type": "string",
"description": "Internal company name of the file, provided at compile-time. level: extended example: Microsoft Corporation"
},
"file_version": {
"type": "string",
"description": "Internal version of the file, provided at compile-time. level: extended example: 6.3.9600.17415"
},
"original_file_name": {
"type": "string",
"description": "Internal name of the file, provided at compile-time. level: extended example: MSPAINT.EXE"
},
"product": {
"type": "string",
"description": "Internal product name of the file, provided at compile-time. level: extended example: Microsoft® Windows® Operating System"
}
},
"code_signature": {
"$ref": "v8CodeSignature",
"description": "These fields contain information about binary code signatures. expected presence: - file - process - dll - driver",
"exists": {
"type": "boolean",
"description": "Boolean to capture if a signature is present. level: core example: 'true'"
},
"status": {
"type": "string",
"description": "Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. level: extended example: ERROR_UNTRUSTED_ROOT"
},
"subject_name": {
"title": "Subject name of the code signer",
"type": "string",
"description": "level: core example: Microsoft Corporation"
},
"digest_algorithm": {
"type": "string",
"description": "The hashing algorithm used to sign the process. This value can distinguish signatures when a file is signed multiple times by the same signer but with a different digest algorithm. level: extended example: sha256"
},
"signing_id": {
"type": "string",
"description": "The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only. level: extended example: com.apple.xpc.proxy"
},
"team_id": {
"type": "string",
"description": "The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only. level: extended example: EQHXZ8M8AV"
},
"timestamp": {
"type": "string",
"description": "Date and time when the code signature was generated and signed. level: extended example: 2021-01-01T12:10:30Z",
"format": "date-time"
},
"trusted": {
"type": "boolean",
"description": "Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. level: extended"
},
"valid": {
"type": "boolean",
"description": "Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. level: extended"
},
"thumbprint_sha1": {
"type": "string",
"description": "Certificate SHA-1 hash that uniquely identifies the code signer. level: extended"
}
}
},
"ecs": {
"$ref": "v8Ecs",
"description": "Meta-information specific to ECS.",
"version": {
"type": "string",
"description": "ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. level: core example: 1.0.0"
}
},
"email": {
"$ref": "ecsv8Email",
"description": "Event details relating to an email transaction. This field set focuses on the email message header, body, and attachments. Network protocols that send and receive email messages such as SMTP are outside the scope of the email.* fields.",
"attachments": [
{
"$ref": "EmailAttachment",
"description": "Objects describing the attachment file sent along with an email message.",
"file": {
"$ref": "EmailAttachmentFile",
"description": "Objects describing the file in attachment sent along with an email message.",
"extension": {
"type": "string",
"description": "Attachment file extension, excluding the leading dot. level: extended example: txt"
},
"mime_type": {
"type": "string",
"description": "The MIME media type of the attachment. This value will typically be extracted from the Content-Type MIME header field. level: extended example: text/plain"
},
"name": {
"type": "string",
"description": "Name of the attachment file including the file extension. level: extended example: attachment.txt"
},
"size": {
"type": "string",
"description": "Attachment file size in bytes. level: extended example: 64329",
"format": "int64"
},
"hash": {
"$ref": "v8Hash",
"description": "Hashes, usually file hashes. The hash fields represent different bitwise hash algorithms and their values. Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for other hashes by lowercasing the hash algorithm name and using underscore separators as appropriate (snake case, e.g. sha3_512). Note that this fieldset is used for common hashes that may be computed over a range of generic bytes. Entity-specific hashes such as ja3 or imphash are placed in the fieldsets to which they relate (tls and pe, respectively). expected presence: - file - process - dll - email.attachments.file",
"md5": {
"type": "string",
"description": "MD5 hash. level: extended"
},
"sha1": {
"type": "string",
"description": "SHA1 hash. level: extended"
},
"sha256": {
"type": "string",
"description": "SHA256 hash. level: extended"
}
}
}
}
],
"bcc": [
{
"$ref": "EmailAddress",
"address": {
"type": "string",
"description": "The email address present in email communication. level: extended example: user@example.com"
}
}
],
"cc": [
{
"$ref": "EmailAddress",
"address": {
"type": "string",
"description": "The email address present in email communication. level: extended example: user@example.com"
}
}
],
"content_type": {
"type": "string",
"description": "Information about how the message is to be displayed. Typically a MIME type. level: extended example: text/plain"
},
"delivery_timestamp": {
"type": "string",
"description": "The date and time when the email message was received by the service or client. level: extended example: 2020-11-10T22:12:34.8196921Z",
"format": "date-time"
},
"direction": {
"type": "string",
"description": "The direction of the message based on the sending and receiving domains. level: extended example: inbound"
},
"from": [
{
"$ref": "EmailAddress",
"address": {
"type": "string",
"description": "The email address present in email communication. level: extended example: user@example.com"
}
}
],
"local_id": {
"type": "string",
"description": "Unique identifier given to the email by the source that created the event. Identifier is not persistent across hops. level: extended example: c26dbea0-80d5-463b-b93c-4e8b708219ce"
},
"message_id": {
"type": "string",
"description": "Identifier from the RFC 5322 Message-ID: email header that refers to a particular email message. level: extended example: 81ce15r2j59@mail01.example.com"
},
"origination_timestamp": {
"title": "The date and time the email message was composed. Many email clients will fill in this value automatically when the message is sent by a user",
"type": "string",
"description": "level: extended example: 2020-11-10T22:12:34.8196921Z",
"format": "date-time"
},
"reply_to": [
{
"$ref": "EmailAddress",
"address": {
"type": "string",
"description": "The email address present in email communication. level: extended example: user@example.com"
}
}
],
"sender": [
{
"$ref": "EmailAddress",
"address": {
"type": "string",
"description": "The email address present in email communication. level: extended example: user@example.com"
}
}
],
"subject": {
"type": "string",
"description": "A brief summary of the topic of the message. level: extended example: Please see this important message."
},
"to": [
{
"$ref": "EmailAddress",
"address": {
"type": "string",
"description": "The email address present in email communication. level: extended example: user@example.com"
}
}
],
"x_mailer": {
"type": "string",
"description": "The name of the application that was used to draft and send the original email message. level: extended example: Spambot v2.5"
}
},
"event": {
"$ref": "v8Event",
"description": "Fields breaking down the event details. The event fields are used for context information about the log or metric event itself. A log is defined as an event containing details of something that happened. Log events must include the time at which the thing happened. Examples of log events include a process starting on a host, a network packet being sent from a source to a destination, or a network connection between a client and a server being initiated or closed. A metric is defined as an event containing one or more numerical measurements and the time at which the measurement was taken. Examples of metric events include memory pressure measured on a host and device temperature. See the event.kind definition in this section for additional details about metric and state events.",
"action": {
"type": "string",
"description": "The action captured by the event. This describes the information in the event. It is more specific than event.category. Examples are group-add, process-started, file-created. The value is normally defined by the implementer. level: core example: user-password-change"
},
"category": [
{
"type": "string"
}
],
"created": {
"type": "string",
"description": "Time when the event was first read by an agent or by your pipeline. event.created contains the date/time when the event was first read by an agent, or by your pipeline. This field is distinct from @timestamp in that @timestamp typically contain the time extracted from the original event. In most situations, these two timestamps will be slightly different. The difference can be used to calculate the delay between your source generating an event, and the time when your agent first processed it. This can be used to monitor your agent's or pipeline's ability to keep up with your event source. In case the two timestamps are identical, @timestamp should be used. level: core example: '2016-05-23T08:05:34.857Z'",
"format": "date-time"
},
"dataset": {
"type": "string",
"description": "Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. level: core example: apache.access"
},
"id": {
"type": "string",
"description": "Unique ID to describe the event. level: core example: 8a4f500d"
},
"ingested": {
"type": "string",
"description": "Timestamp when an event arrived in the central data store. This is different from @timestamp, which is when the event originally occurred. It's also different from event.created, which is meant to capture the first time an agent saw the event. In normal conditions, assuming no tampering, the timestamps should chronologically look like this: @timestamp < event.created < event.ingested. level: core example: '2016-05-23T08:05:35.101Z'",
"format": "date-time"
},
"kind": {
"type": "string",
"description": "The kind of the event. The highest categorization field in the hierarchy. This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. event.kind gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data is coming in at a regular interval or not. level: core example: alert allowed_values: - alert This value indicates an event such as an alert or notable event, triggered by a detection rule executing externally to the Elastic Stack. event.kind:alert is often populated for events coming from firewalls, intrusion detection systems, endpoint detection and response systems, and so on. This value is not used by Elastic solutions for alert documents that are created by rules executing within the Kibana alerting framework. asset This value indicates events whose primary purpose is to store an inventory of assets/entities and their attributes. Assets/entities are objects (such as users and hosts) that are expected to be subjects of detailed analysis within the system. Examples include lists of user identities or accounts ingested from directory services such as Active Directory (AD), inventory of hosts pulled from configuration management databases (CMDB), and lists of cloud storage buckets pulled from cloud provider APIs. This value is used by Elastic Security for asset management solutions. event.kind: asset is not used for normal system events or logs that are coming from an asset/entity, nor is it used for system events or logs coming from a directory or CMDB system. enrichment The enrichment value indicates an event collected to provide additional context, often to other events. An example is collecting indicators of compromise (IOCs) from a threat intelligence provider with the intent to use those values to enrich other events. The IOC events from the intelligence provider should be categorized as event.kind:enrichment. event This value is the most general and most common value for this field. It is used to represent events that indicate that something happened. metric This value is used to indicate that this event describes a numeric measurement taken at given point in time. Examples include CPU utilization, memory usage, or device temperature. Metric events are often collected on a predictable frequency, such as once every few seconds, or once a minute, but can also be used to describe ad-hoc numeric metric queries. state The state value is similar to metric, indicating that this event describes a measurement taken at given point in time, except that the measurement does not result in a numeric value, but rather one of a fixed set of categorical values that represent conditions or states. Examples include periodic events reporting Elasticsearch cluster state (green/yellow/red), the state of a TCP connection (open, closed, fin_wait, etc.), the state of a host with respect to a software vulnerability (vulnerable, not vulnerable), and the state of a system regarding compliance with a regulatory standard (compliant, not compliant). Note that an event that describes a change of state would not use event.kind:state, but instead would use 'event.kind:event' since a state change fits the more general event definition of something that happened. State events are often collected on a predictable frequency, such as once every few seconds, once a minute, once an hour, or once a day, but can also be used to describe ad-hoc state queries. pipeline_error This value indicates that an error occurred during the ingestion of this event, and that event data may be missing, inconsistent, or incorrect. event.kind:pipeline_error is often associated with parsing errors. signal This value is used by Elastic solutions (e.g., Security, Observability) for alert documents that are created by rules executing within the Kibana alerting framework. Usage of this value is reserved, and data ingestion pipelines must not populate event.kind with the value 'signal'."
},
"module": {
"type": "string",
"description": "Name of the module this data is coming from. If your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), event.module should contain the name of this module. level: core example: apache"
},
"outcome": {
"type": "string",
"description": "The outcome of the event. The lowest level categorization field in the hierarchy. This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy. event.outcome simply denotes whether the event represents a success or a failure from the perspective of the entity that produced the event. Note that when a single transaction is described in multiple events, each event may populate different values of event.outcome, according to their perspective. Also note that in the case of a compound event (a single event that contains multiple logical events), this field should be populated with the value that best captures the overall success or failure from the perspective of the event producer. Further note that not all events will have an associated outcome. For example, this field is generally not populated for metric events, events with event.type:info, or any events for which an outcome does not make logical sense. level: core"
},
"provider": {
"type": "string",
"description": "Source of the event. Event transports such as Syslog or the Windows Event Log typically mention the source of an event. It can be the name of the software that generated the event (e.g. Sysmon, httpd), or of a subsystem of the operating system (kernel, Microsoft-Windows-Security-Auditing). level: extended example: kernel"
},
"reason": {
"type": "string",
"description": "Reason why this event happened, according to the source. This describes the why of a particular action or outcome captured in the event. Where event.action captures the action from the event, event.reason describes why that action was taken. For example, a web proxy with an event.action which denied the request may also populate event.reason with the reason why (e.g. blocked site). level: extended example: 'Terminated an unexpected process'"
},
"risk_score": {
"type": "number",
"description": "Risk score or priority of the event (e.g. security solutions). Use your system's original value here. level: core",
"format": "float"
},
"severity": {
"type": "string",
"description": "Numeric severity of the event. The numeric severity of the event according to your event source. What the different severity values mean can be different between sources and use cases. It's up to the implementer to make sure severities are consistent across events from the same source. The Syslog severity belongs in log.syslog.severity.code. event.severity is meant to represent the severity according to the event source (e.g. firewall, IDS). If the event source does not publish its own severity, you may optionally copy the log.syslog.severity.code to event.severity. level: core example: 7",
"format": "int64"
},
"type": [
{
"type": "string"
}
]
},
"file": {
"$ref": "ecsv8File",
"description": "Fields describing the communication path over which the event happened. The network is defined as the communication path over which a host or network event happens. The network.* fields should be populated with details about the network activity associated with an event.",
"accessed": {
"type": "string",
"description": "Last time the file was accessed. Note that not all filesystems keep track of access time. level: extended example: 2024-11-24T18:34:23.000Z",
"format": "date-time"
},
"attributes": [
{
"type": "string"
}
],
"created": {
"type": "string",
"description": "File creation time. Note that not all filesystems store the creation time. level: extended example: 2024-11-24T18:34:23.000Z",
"format": "date-time"
},
"ctime": {
"type": "string",
"description": "Last time the file attributes or metadata changed. Note that changes to the file content will update mtime. This implies ctime will be adjusted at the same time, since mtime is an attribute of the file. level: extended",
"format": "date-time"
},
"device": {
"type": "string",
"description": "Device that is the source of the file. The device is typically a name, number, or combination of both, that the operating system uses to identify a piece of hardware. It is recommended to use the value that the operating system uses to identify the device. level: extended example: sda"
},
"directory": {
"type": "string",
"description": "Directory where the file is located. It should include the drive letter, when appropriate. level: extended example: '/home/alice'"
},
"drive_letter": {
"type": "string",
"description": "Drive letter where the file is located. This field is only relevant on Windows. The value should be uppercase, and not include the colon. level: extended example: C"
},
"extension": {
"type": "string",
"description": "File extension, excluding the leading dot. Note that when the file name has multiple extensions (example.tar.gz), only the last one should be captured ('gz', not 'tar.gz'). level: extended example: png"
},
"fork_name": {
"type": "string",
"description": "A fork is additional data associated with a filesystem object. On Linux, a resource fork is used to store additional data with a filesystem object. A file always has at least one fork for the data portion, and additional forks may exist. On NTFS, this is analogous to an Alternate Data Stream (ADS), and the default data stream for a file is just called $DATA. Zone.Identifier is commonly used by Windows to track contents downloaded from the Internet. An ADS is typically of the form: C:\path\to\filename.extension:some_fork_name, and some_fork_name is the value that should populate fork_name. filename.extension should populate file.name, and extension should populate file.extension. The full path, file.path, will include the fork name. level: extended example: Zone.Identifer"
},
"gid": {
"type": "string",
"description": "The group ID (GID) of the file owner. level: extended example: 1001"
},
"group": {
"type": "string",
"description": "Primary group name of the file. level: extended example: alice"
},
"inode": {
"type": "string",
"description": "Inode representing the file in the filesystem. level: extended example: 256383"
},
"mime_type": {
"type": "string",
"description": "Media type of file, document, or arrangement of bytes. MIME type should identify the format of the file or stream of bytes using https://www.iana.org/assignments/media-types/media-types.xhtml[IANA official types], where possible. When more than one type is applicable, the most specific type should be used. level: extended"
},
"mode": {
"type": "string",
"description": "Mode of the file in octal representation. level: extended example: 0640"
},
"mtime": {
"type": "string",
"description": "Last time the file content was modified. level: extended example: 2024-11-24T18:34:23.000Z",
"format": "date-time"
},
"name": {
"type": "string",
"description": "Name of the file including the extension, without the directory. level: extended example: example.png"
},
"owner": {
"type": "string",
"description": "File owner's username. level: extended example: alice"
},
"path": {
"type": "string",
"description": "Full path to the file, including the file name. It should include the drive letter, when appropriate. level: extended example: '/home/alice/example.png'"
},
"size": {
"type": "string",
"description": "File size in bytes. Only relevant when file.type is 'file'. level: extended example: 16384",
"format": "int64"
},
"target_path": {
"type": "string",
"description": "Target path for symlinks. level: extended example: /etc/passwd"
},
"type": {
"type": "string",
"description": "File type (file, dir, or symlink). level: extended example: file"
},
"uid": {
"type": "string",
"description": "The user ID (UID) or security identifier (SID) of the file owner. level: extended example: 1001"
},
"code_signature": {
"$ref": "v8CodeSignature",
"description": "These fields contain information about binary code signatures. expected presence: - file - process - dll - driver",
"exists": {
"type": "boolean",
"description": "Boolean to capture if a signature is present. level: core example: 'true'"
},
"status": {
"type": "string",
"description": "Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. level: extended example: ERROR_UNTRUSTED_ROOT"
},
"subject_name": {
"title": "Subject name of the code signer",
"type": "string",
"description": "level: core example: Microsoft Corporation"
},
"digest_algorithm": {
"type": "string",
"description": "The hashing algorithm used to sign the process. This value can distinguish signatures when a file is signed multiple times by the same signer but with a different digest algorithm. level: extended example: sha256"
},
"signing_id": {
"type": "string",
"description": "The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only. level: extended example: com.apple.xpc.proxy"
},
"team_id": {
"type": "string",
"description": "The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only. level: extended example: EQHXZ8M8AV"
},
"timestamp": {
"type": "string",
"description": "Date and time when the code signature was generated and signed. level: extended example: 2021-01-01T12:10:30Z",
"format": "date-time"
},
"trusted": {
"type": "boolean",
"description": "Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. level: extended"
},
"valid": {
"type": "boolean",
"description": "Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. level: extended"
},
"thumbprint_sha1": {
"type": "string",
"description": "Certificate SHA-1 hash that uniquely identifies the code signer. level: extended"
}
},
"hash": {
"$ref": "v8Hash",
"description": "Hashes, usually file hashes. The hash fields represent different bitwise hash algorithms and their values. Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for other hashes by lowercasing the hash algorithm name and using underscore separators as appropriate (snake case, e.g. sha3_512). Note that this fieldset is used for common hashes that may be computed over a range of generic bytes. Entity-specific hashes such as ja3 or imphash are placed in the fieldsets to which they relate (tls and pe, respectively). expected presence: - file - process - dll - email.attachments.file",
"md5": {
"type": "string",
"description": "MD5 hash. level: extended"
},
"sha1": {
"type": "string",
"description": "SHA1 hash. level: extended"
},
"sha256": {
"type": "string",
"description": "SHA256 hash. level: extended"
}
},
"pe": {
"$ref": "v8Pe",
"description": {
"type": "string",
"description": "Internal description of the file, provided at compile-time. level: extended example: 'Paint'"
},
"architecture": {
"type": "string",
"description": "CPU architecture target for the file. level: extended example: 'x64'"
},
"company": {
"type": "string",
"description": "Internal company name of the file, provided at compile-time. level: extended example: Microsoft Corporation"
},
"file_version": {
"type": "string",
"description": "Internal version of the file, provided at compile-time. level: extended example: 6.3.9600.17415"
},
"original_file_name": {
"type": "string",
"description": "Internal name of the file, provided at compile-time. level: extended example: MSPAINT.EXE"
},
"product": {
"type": "string",
"description": "Internal product name of the file, provided at compile-time. level: extended example: Microsoft® Windows® Operating System"
}
}
},
"host": {
"$ref": "v8Host",
"description": "Fields describing the relevant computing instance. A host is defined as a general computing instance. ECS host.* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes.",
"architecture": {
"type": "string",
"description": "Operating system architecture. level: core example: 'x86_64'"
},
"domain": {
"type": "string",
"description": "Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider. level: core example: CONTOSO"
},
"hostname": {
"type": "string",
"description": "Hostname of the host. It normally contains what the hostname command returns on the host machine. level: core example: 'server2k19'"
},
"id": {
"type": "string",
"description": "Unique host id. As hostname is not always unique, use values that are meaningful in your environment. level: core example: The current usage of beat.name. example: GUID of endpoint"
},
"ip": [
{
"type": "string"
}
],
"mac": [
{
"type": "string"
}
],
"name": {
"type": "string",
"description": "Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. level: core example: 'server2k19.alonim.local'"
},
"type": {
"type": "string",
"description": "Type of host. For Cloud providers this can be the machine type like t2.medium. If vm, this could be the container, for example, or other information meaningful in your environment. level: core example: 'virtual' example: 'physical'"
},
"os": {
"$ref": "v8Os",
"description": "OS fields contain information about the operating system. The OS fields contain information about the operating system. top_level: false expected presence: - Observer - Host - UserAgent",
"name": {
"type": "string",
"description": "Operating system name, without the version. level: extended"
},
"type": {
"type": "string",
"description": "Which commercial OS family (one of: linux, macos, unix, windows, ios or android). Use the os.type field to categorize the operating system into one of the broad commercial families. If the OS you're dealing with is not listed as an expected value, the field should not be populated. Please let us know by opening an issue with ECS, to propose its addition. expected_values: - linux - macos - unix - windows - ios - android level: extended example: macos"
},
"version": {
"type": "string",
"description": "Operating system version as a raw string. level: extended"
}
},
"geo": {
"$ref": "v8Geo",
"description": "Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied. Note also that the geo fields are not expected to be used directly at the root of the events.",
"city_name": {
"type": "string",
"description": "City name. level: core example: Montreal"
},
"continent_code": {
"type": "string",
"description": "Two-letter code representing continent's name. level: core example: NA"
},
"continent_name": {
"type": "string",
"description": "Name of the continent. level: core example: North America"
},
"country_iso_code": {
"type": "string",
"description": "Country ISO code. level: core example: CA"
},
"country_name": {
"type": "string",
"description": "Country name. level: core example: Canada"
},
"location": {
"type": "string",
"description": "Longitude and latitude. level: core example: { 'lon': -73.614830, 'lat': 45.505918 }"
},
"name": {
"type": "string",
"description": "User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. level: extended example: boston-dc"
},
"postal_code": {
"type": "string",
"description": "Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. level: core example: 94040"
},
"region_iso_code": {
"type": "string",
"description": "Region ISO code. level: core example: CA-QC"
},
"region_name": {
"type": "string",
"description": "Region name. level: core example: Quebec"
},
"timezone": {
"type": "string",
"description": "The time zone of the location, such as IANA time zone name. level: core example: America/Argentina/Buenos_Aires"
}
}
},
"network": {
"$ref": "v8Network",
"description": "Fields describing the communication path over which the event happened. The network is defined as the communication path over which a host or network event happens. The network.* fields should be populated with details about the network activity associated with an event.",
"application": {
"type": "string",
"description": "Application level protocol name. When a specific application or service is identified from network connection details (source/dest IPs, ports, certificates, or wire format), this field captures the application's or service's name. For example, the original event identifies the network connection being from a specific web service in a https network connection, like facebook or twitter. The field value must be normalized to lowercase for querying. level: extended example: aim"
},
"community_id": {
"type": "string",
"description": "A hash of source and destination IPs and ports. A hash of source and destination IPs and ports, as well as the protocol used in a communication. This is a tool-agnostic standard to identify flows. Learn more at https://github.com/corelight/community-id-spec. level: extended example: '1:hO+sN4H+MG5MY/8hIrXPqc4ZQz0='"
},
"direction": {
"type": "string",
"description": "Direction of the network traffic. When mapping events from a host-based monitoring context, populate this field from the host's point of view, using the values 'ingress' or 'egress'. When mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of the network perimeter, using the values 'inbound', 'outbound', 'internal' or 'external'. Note that 'internal' is not crossing perimeter boundaries, and is meant to describe communication between two hosts within the perimeter. Note also that 'external' is meant to describe traffic between two hosts that are external to the perimeter. This could for example be useful for ISPs or VPN service providers. level: core expected_values: - ingress - egress - inbound - outbound - internal - external - unknown example: inbound"
},
"forwarded_ip": {
"type": "string",
"description": "Host IP address when the source IP address is the proxy. level: core example: 192.1.1.2"
},
"iana_number": {
"type": "string",
"description": "IANA Protocol Number. IANA Protocol Number (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Standardized list of protocols. This aligns well with NetFlow and sFlow related logs which use the IANA Protocol Number. level: extended example: 6"
},
"name": {
"type": "string",
"description": "Name given by operators to sections of their network. level: extended example: Guest Wifi"
},
"protocol": {
"type": "string",
"description": "Application protocol name. In the OSI Model this would be the Application Layer protocol. For example, http, dns, or ssh. The field value must be normalized to lowercase for querying. level: core example: http"
},
"transport": {
"type": "string",
"description": "Protocol Name corresponding to the field iana_number. Same as network.iana_number, but instead using the Keyword name of the transport layer (udp, tcp, ipv6-icmp, etc.) The field value must be normalized to lowercase for querying. level: core example: tcp"
},
"type": {
"title": "In the OSI Model this would be the Network Layer. ipv4, ipv6, ipsec, pim, etc",
"type": "string",
"description": "The field value must be normalized to lowercase for querying. level: core example: ipv4"
}
},
"observer": {
"$ref": "v8Observer",
"description": "Fields describing an entity observing the event from outside the host. An observer is defined as a special network, security, or application device used to detect, observe, or create network, security, or application-related events and metrics. This could be a custom hardware appliance or a server that has been configured to run special network, security, or application software. Examples include firewalls, web proxies, intrusion detection/prevention systems, network monitoring sensors, web application firewalls, data loss prevention systems, and APM servers. The observer.* fields shall be populated with details of the system, if any, that detects, observes and/or creates a network, security, or application event or metric. Message queues and ETL components used in processing events or metrics are not considered observers in ECS.",
"egress": {
"$ref": "ObserverIngressEgress",
"description": "Observer.egress and observer.ingress holds information like interface number and name, vlan, and zone information to classify egress or ingress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic.",
"zone": {
"type": "string",
"description": "Network zone of inbound or outbound traffic as reported by the observer to categorize the destination area of ingress or egress traffic, e.g. Internal, External, DMZ, HR, Legal, etc. level: extended example: Public_Internet"
}
},
"hostname": {
"type": "string",
"description": "Hostname of the observer. level: core"
},
"ingress": {
"$ref": "ObserverIngressEgress",
"description": "Observer.egress and observer.ingress holds information like interface number and name, vlan, and zone information to classify egress or ingress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic.",
"zone": {
"type": "string",
"description": "Network zone of inbound or outbound traffic as reported by the observer to categorize the destination area of ingress or egress traffic, e.g. Internal, External, DMZ, HR, Legal, etc. level: extended example: Public_Internet"
}
},
"ip": [
{
"type": "string"
}
],
"mac": [
{
"type": "string"
}
],
"name": {
"type": "string",
"description": "Custom name of the observer. This is a name that can be given to an observer. This can be helpful for example if multiple firewalls of the same model are used in an organization. If no custom name is needed, the field can be left empty. level: extended example: 1_proxySG"
},
"product": {
"type": "string",
"description": "The product name of the observer. level: extended example: s200"
},
"serial_number": {
"type": "string",
"description": "Observer serial number. level: extended"
},
"type": {
"type": "string",
"description": "The type of the observer the data is coming from. There is no predefined list of observer types. Some examples are forwarder, firewall, ids, ips, proxy, poller, sensor, APM server. level: core example: firewall"
},
"vendor": {
"type": "string",
"description": "Vendor name of the observer. level: core example: ESET"
},
"version": {
"type": "string",
"description": "Observer version. level: core"
},
"geo": {
"$ref": "v8Geo",
"description": "Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied. Note also that the geo fields are not expected to be used directly at the root of the events.",
"city_name": {
"type": "string",
"description": "City name. level: core example: Montreal"
},
"continent_code": {
"type": "string",
"description": "Two-letter code representing continent's name. level: core example: NA"
},
"continent_name": {
"type": "string",
"description": "Name of the continent. level: core example: North America"
},
"country_iso_code": {
"type": "string",
"description": "Country ISO code. level: core example: CA"
},
"country_name": {
"type": "string",
"description": "Country name. level: core example: Canada"
},
"location": {
"type": "string",
"description": "Longitude and latitude. level: core example: { 'lon': -73.614830, 'lat': 45.505918 }"
},
"name": {
"type": "string",
"description": "User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. level: extended example: boston-dc"
},
"postal_code": {
"type": "string",
"description": "Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. level: core example: 94040"
},
"region_iso_code": {
"type": "string",
"description": "Region ISO code. level: core example: CA-QC"
},
"region_name": {
"type": "string",
"description": "Region name. level: core example: Quebec"
},
"timezone": {
"type": "string",
"description": "The time zone of the location, such as IANA time zone name. level: core example: America/Argentina/Buenos_Aires"
}
}
},
"process": {
"$ref": "ecsv8Process",
"description": "These fields contain information about a process. These fields can help you correlate metrics information with a process id/name from a log message. The process.pid often stays in the metric itself and is copied to the global field for correlation. expected presence: - Process.parent - Process.entry_leader - Process.session_leader - Process.group_leader - Process.parent.group_leader - Process.entry_leader.parent - Process.session_leader.parent - Process.entry_leader.parent.session_leader - Process.session_leader.parent.session_leader - Process.previous",
"args": [
{
"type": "string"
}
],
"args_count": {
"type": "string",
"description": "Length of the process.args array. This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity. level: extended example: 4",
"format": "int64"
},
"command_line": {
"type": "string",
"description": "Full command line that started the process. Full command line that started the process, including the absolute path to the executable, and all arguments. Some arguments may be filtered to protect sensitive information. level: extended example: '/usr/bin/ssh -l user 10.0.0.16'"
},
"end": {
"type": "string",
"description": "The time the process ended. level: extended example: '2016-05-23T08:05:34.853Z'",
"format": "date-time"
},
"entity_id": {
"type": "string",
"description": "Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts. level: extended example: c2c455d9f99375d"
},
"executable": {
"type": "string",
"description": "Absolute path to the process executable. level: extended example: /usr/bin/ssh multi_fields"
},
"name": {
"type": "string",
"description": "Process name. level: extended"
},
"pid": {
"type": "string",
"description": "Process id. level: core example: 4242 JSON string",
"format": "uint64"
},
"start": {
"type": "string",
"description": "The time the process started. level: extended example: '2016-05-23T08:05:34.853Z'",
"format": "date-time"
},
"code_signature": {
"$ref": "v8CodeSignature",
"description": "These fields contain information about binary code signatures. expected presence: - file - process - dll - driver",
"exists": {
"type": "boolean",
"description": "Boolean to capture if a signature is present. level: core example: 'true'"
},
"status": {
"type": "string",
"description": "Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. level: extended example: ERROR_UNTRUSTED_ROOT"
},
"subject_name": {
"title": "Subject name of the code signer",
"type": "string",
"description": "level: core example: Microsoft Corporation"
},
"digest_algorithm": {
"type": "string",
"description": "The hashing algorithm used to sign the process. This value can distinguish signatures when a file is signed multiple times by the same signer but with a different digest algorithm. level: extended example: sha256"
},
"signing_id": {
"type": "string",
"description": "The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only. level: extended example: com.apple.xpc.proxy"
},
"team_id": {
"type": "string",
"description": "The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only. level: extended example: EQHXZ8M8AV"
},
"timestamp": {
"type": "string",
"description": "Date and time when the code signature was generated and signed. level: extended example: 2021-01-01T12:10:30Z",
"format": "date-time"
},
"trusted": {
"type": "boolean",
"description": "Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. level: extended"
},
"valid": {
"type": "boolean",
"description": "Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. level: extended"
},
"thumbprint_sha1": {
"type": "string",
"description": "Certificate SHA-1 hash that uniquely identifies the code signer. level: extended"
}
},
"hash": {
"$ref": "v8Hash",
"description": "Hashes, usually file hashes. The hash fields represent different bitwise hash algorithms and their values. Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for other hashes by lowercasing the hash algorithm name and using underscore separators as appropriate (snake case, e.g. sha3_512). Note that this fieldset is used for common hashes that may be computed over a range of generic bytes. Entity-specific hashes such as ja3 or imphash are placed in the fieldsets to which they relate (tls and pe, respectively). expected presence: - file - process - dll - email.attachments.file",
"md5": {
"type": "string",
"description": "MD5 hash. level: extended"
},
"sha1": {
"type": "string",
"description": "SHA1 hash. level: extended"
},
"sha256": {
"type": "string",
"description": "SHA256 hash. level: extended"
}
},
"parent": {
"$ref": "ProcessParent",
"description": "Parent process information.",
"args": [
{
"type": "string"
}
],
"args_count": {
"type": "string",
"description": "Length of the process.args array. This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity. level: extended example: 4",
"format": "int64"
},
"command_line": {
"type": "string",
"description": "Full command line that started the process. Full command line that started the process, including the absolute path to the executable, and all arguments. Some arguments may be filtered to protect sensitive information. level: extended example: '/usr/bin/ssh -l user 10.0.0.16'"
},
"entity_id": {
"type": "string",
"description": "Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts. level: extended example: c2c455d9f99375d"
},
"executable": {
"type": "string",
"description": "Absolute path to the process executable. level: extended example: /usr/bin/ssh multi_fields"
},
"name": {
"type": "string",
"description": "Process name. level: extended"
},
"pid": {
"type": "string",
"description": "Process id. level: core example: 4242 JSON string",
"format": "uint64"
},
"start": {
"type": "string",
"description": "The time the process started. level: extended example: '2016-05-23T08:05:34.853Z'",
"format": "date-time"
},
"code_signature": {
"$ref": "v8CodeSignature",
"description": "These fields contain information about binary code signatures. expected presence: - file - process - dll - driver",
"exists": {
"type": "boolean",
"description": "Boolean to capture if a signature is present. level: core example: 'true'"
},
"status": {
"type": "string",
"description": "Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. level: extended example: ERROR_UNTRUSTED_ROOT"
},
"subject_name": {
"title": "Subject name of the code signer",
"type": "string",
"description": "level: core example: Microsoft Corporation"
},
"digest_algorithm": {
"type": "string",
"description": "The hashing algorithm used to sign the process. This value can distinguish signatures when a file is signed multiple times by the same signer but with a different digest algorithm. level: extended example: sha256"
},
"signing_id": {
"type": "string",
"description": "The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only. level: extended example: com.apple.xpc.proxy"
},
"team_id": {
"type": "string",
"description": "The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only. level: extended example: EQHXZ8M8AV"
},
"timestamp": {
"type": "string",
"description": "Date and time when the code signature was generated and signed. level: extended example: 2021-01-01T12:10:30Z",
"format": "date-time"
},
"trusted": {
"type": "boolean",
"description": "Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. level: extended"
},
"valid": {
"type": "boolean",
"description": "Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. level: extended"
},
"thumbprint_sha1": {
"type": "string",
"description": "Certificate SHA-1 hash that uniquely identifies the code signer. level: extended"
}
},
"hash": {
"$ref": "v8Hash",
"description": "Hashes, usually file hashes. The hash fields represent different bitwise hash algorithms and their values. Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for other hashes by lowercasing the hash algorithm name and using underscore separators as appropriate (snake case, e.g. sha3_512). Note that this fieldset is used for common hashes that may be computed over a range of generic bytes. Entity-specific hashes such as ja3 or imphash are placed in the fieldsets to which they relate (tls and pe, respectively). expected presence: - file - process - dll - email.attachments.file",
"md5": {
"type": "string",
"description": "MD5 hash. level: extended"
},
"sha1": {
"type": "string",
"description": "SHA1 hash. level: extended"
},
"sha256": {
"type": "string",
"description": "SHA256 hash. level: extended"
}
},
"group_leader": {
"$ref": "ParentProcessReference",
"description": "Simplified process reference containing only entity_id, pid and start time.",
"entity_id": {
"type": "string",
"description": "Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts. level: extended example: c2c455d9f99375d"
},
"pid": {
"type": "string",
"description": "Process id. level: core example: 4242 JSON string",
"format": "uint64"
},
"start": {
"type": "string",
"description": "The time the process started. level: extended example: '2016-05-23T08:05:34.853Z'",
"format": "date-time"
}
},
"responsible": {
"$ref": "ParentProcessReference",
"description": "Simplified process reference containing only entity_id, pid and start time.",
"entity_id": {
"type": "string",
"description": "Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts. level: extended example: c2c455d9f99375d"
},
"pid": {
"type": "string",
"description": "Process id. level: core example: 4242 JSON string",
"format": "uint64"
},
"start": {
"type": "string",
"description": "The time the process started. level: extended example: '2016-05-23T08:05:34.853Z'",
"format": "date-time"
}
},
"interactive": {
"type": "boolean",
"description": "Whether the process is connected to an interactive shell. Process interactivity is inferred from the processes file descriptors. If the character device for the controlling tty is the same as stdin and stderr for the process, the process is considered interactive. Note: A non-interactive process can belong to an interactive session and is simply one that does not have open file descriptors reading the controlling TTY on FD 0 (stdin) or writing to the controlling TTY on FD 2 (stderr). A backgrounded process is still considered interactive if stdin and stderr are connected to the controlling TTY. level: extended"
}
},
"pe": {
"$ref": "v8Pe",
"description": {
"type": "string",
"description": "Internal description of the file, provided at compile-time. level: extended example: 'Paint'"
},
"architecture": {
"type": "string",
"description": "CPU architecture target for the file. level: extended example: 'x64'"
},
"company": {
"type": "string",
"description": "Internal company name of the file, provided at compile-time. level: extended example: Microsoft Corporation"
},
"file_version": {
"type": "string",
"description": "Internal version of the file, provided at compile-time. level: extended example: 6.3.9600.17415"
},
"original_file_name": {
"type": "string",
"description": "Internal name of the file, provided at compile-time. level: extended example: MSPAINT.EXE"
},
"product": {
"type": "string",
"description": "Internal product name of the file, provided at compile-time. level: extended example: Microsoft® Windows® Operating System"
}
},
"user": {
"$ref": "ecsv8User",
"description": "Fields to describe the user relevant to the event. The user fields describe information about the user that is relevant to the event. Fields can have one entry or multiple entries. If a user has more than one id, provide an array that includes all of them. expected presence: - client - destination - server - source.user.target - user.effective - user.changes - process.user - process.saved_user - process.real_user - process.attested_user",
"domain": {
"type": "string",
"description": "Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"email": {
"type": "string",
"description": "User email address. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier of the user. level: core example: S-1-5-21-202424912787-2692429404-2351956786-1000"
},
"name": {
"type": "string",
"description": "Short name or login of the user. level: core example: a.einstein"
},
"full_name": {
"type": "string",
"description": "User’s full name, if available. level: core example: Albert Einstein"
},
"target": {
"$ref": "v8UserUserReference",
"domain": {
"type": "string",
"description": "Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier of the user. level: core example: S-1-5-21-202424912787-2692429404-2351956786-1000"
},
"name": {
"type": "string",
"description": "Short name or login of the user. level: core example: a.einstein"
},
"full_name": {
"type": "string",
"description": "User’s full name, if available. level: core example: Albert Einstein"
}
},
"group": {
"$ref": "ecsv8Group",
"description": "The group fields are meant to represent groups that are relevant to the event.",
"domain": {
"type": "string",
"description": "Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier for the group on the system/platform. level: extended"
},
"name": {
"type": "string",
"description": "Name of the group. level: extended"
}
},
"changes": {
"$ref": "v8UserUserReference",
"domain": {
"type": "string",
"description": "Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier of the user. level: core example: S-1-5-21-202424912787-2692429404-2351956786-1000"
},
"name": {
"type": "string",
"description": "Short name or login of the user. level: core example: a.einstein"
},
"full_name": {
"type": "string",
"description": "User’s full name, if available. level: core example: Albert Einstein"
}
}
},
"group": {
"$ref": "ecsv8Group",
"description": "The group fields are meant to represent groups that are relevant to the event.",
"domain": {
"type": "string",
"description": "Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier for the group on the system/platform. level: extended"
},
"name": {
"type": "string",
"description": "Name of the group. level: extended"
}
},
"group_leader": {
"$ref": "ProcessGroupLeader",
"description": "Group Leader process information.",
"args": [
{
"type": "string"
}
],
"args_count": {
"type": "string",
"description": "Length of the process.args array. This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity. level: extended example: 4",
"format": "int64"
},
"command_line": {
"type": "string",
"description": "Full command line that started the process. Full command line that started the process, including the absolute path to the executable, and all arguments. Some arguments may be filtered to protect sensitive information. level: extended example: '/usr/bin/ssh -l user 10.0.0.16'"
},
"entity_id": {
"type": "string",
"description": "Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts. level: extended example: c2c455d9f99375d"
},
"executable": {
"type": "string",
"description": "Absolute path to the process executable. level: extended example: /usr/bin/ssh multi_fields"
},
"name": {
"type": "string",
"description": "Process name. level: extended"
},
"pid": {
"type": "string",
"description": "Process id. level: core example: 4242 JSON string",
"format": "uint64"
},
"start": {
"type": "string",
"description": "The time the process started. level: extended example: '2016-05-23T08:05:34.853Z'",
"format": "date-time"
},
"code_signature": {
"$ref": "v8CodeSignature",
"description": "These fields contain information about binary code signatures. expected presence: - file - process - dll - driver",
"exists": {
"type": "boolean",
"description": "Boolean to capture if a signature is present. level: core example: 'true'"
},
"status": {
"type": "string",
"description": "Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. level: extended example: ERROR_UNTRUSTED_ROOT"
},
"subject_name": {
"title": "Subject name of the code signer",
"type": "string",
"description": "level: core example: Microsoft Corporation"
},
"digest_algorithm": {
"type": "string",
"description": "The hashing algorithm used to sign the process. This value can distinguish signatures when a file is signed multiple times by the same signer but with a different digest algorithm. level: extended example: sha256"
},
"signing_id": {
"type": "string",
"description": "The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only. level: extended example: com.apple.xpc.proxy"
},
"team_id": {
"type": "string",
"description": "The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only. level: extended example: EQHXZ8M8AV"
},
"timestamp": {
"type": "string",
"description": "Date and time when the code signature was generated and signed. level: extended example: 2021-01-01T12:10:30Z",
"format": "date-time"
},
"trusted": {
"type": "boolean",
"description": "Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. level: extended"
},
"valid": {
"type": "boolean",
"description": "Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. level: extended"
},
"thumbprint_sha1": {
"type": "string",
"description": "Certificate SHA-1 hash that uniquely identifies the code signer. level: extended"
}
},
"hash": {
"$ref": "v8Hash",
"description": "Hashes, usually file hashes. The hash fields represent different bitwise hash algorithms and their values. Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for other hashes by lowercasing the hash algorithm name and using underscore separators as appropriate (snake case, e.g. sha3_512). Note that this fieldset is used for common hashes that may be computed over a range of generic bytes. Entity-specific hashes such as ja3 or imphash are placed in the fieldsets to which they relate (tls and pe, respectively). expected presence: - file - process - dll - email.attachments.file",
"md5": {
"type": "string",
"description": "MD5 hash. level: extended"
},
"sha1": {
"type": "string",
"description": "SHA1 hash. level: extended"
},
"sha256": {
"type": "string",
"description": "SHA256 hash. level: extended"
}
},
"interactive": {
"type": "boolean",
"description": "Whether the process is connected to an interactive shell. Process interactivity is inferred from the processes file descriptors. If the character device for the controlling tty is the same as stdin and stderr for the process, the process is considered interactive. Note: A non-interactive process can belong to an interactive session and is simply one that does not have open file descriptors reading the controlling TTY on FD 0 (stdin) or writing to the controlling TTY on FD 2 (stderr). A backgrounded process is still considered interactive if stdin and stderr are connected to the controlling TTY. level: extended"
}
},
"responsible": {
"$ref": "ProcessResponsibleProcess",
"description": "MacOS-specific responsible process information.",
"args": [
{
"type": "string"
}
],
"args_count": {
"type": "string",
"description": "Length of the process.args array. This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity. level: extended example: 4",
"format": "int64"
},
"command_line": {
"type": "string",
"description": "Full command line that started the process. Full command line that started the process, including the absolute path to the executable, and all arguments. Some arguments may be filtered to protect sensitive information. level: extended example: '/usr/bin/ssh -l user 10.0.0.16'"
},
"entity_id": {
"type": "string",
"description": "Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts. level: extended example: c2c455d9f99375d"
},
"executable": {
"type": "string",
"description": "Absolute path to the process executable. level: extended example: /usr/bin/ssh multi_fields"
},
"name": {
"type": "string",
"description": "Process name. level: extended"
},
"pid": {
"type": "string",
"description": "Process id. level: core example: 4242 JSON string",
"format": "uint64"
},
"start": {
"type": "string",
"description": "The time the process started. level: extended example: '2016-05-23T08:05:34.853Z'",
"format": "date-time"
},
"code_signature": {
"$ref": "v8CodeSignature",
"description": "These fields contain information about binary code signatures. expected presence: - file - process - dll - driver",
"exists": {
"type": "boolean",
"description": "Boolean to capture if a signature is present. level: core example: 'true'"
},
"status": {
"type": "string",
"description": "Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. level: extended example: ERROR_UNTRUSTED_ROOT"
},
"subject_name": {
"title": "Subject name of the code signer",
"type": "string",
"description": "level: core example: Microsoft Corporation"
},
"digest_algorithm": {
"type": "string",
"description": "The hashing algorithm used to sign the process. This value can distinguish signatures when a file is signed multiple times by the same signer but with a different digest algorithm. level: extended example: sha256"
},
"signing_id": {
"type": "string",
"description": "The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only. level: extended example: com.apple.xpc.proxy"
},
"team_id": {
"type": "string",
"description": "The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only. level: extended example: EQHXZ8M8AV"
},
"timestamp": {
"type": "string",
"description": "Date and time when the code signature was generated and signed. level: extended example: 2021-01-01T12:10:30Z",
"format": "date-time"
},
"trusted": {
"type": "boolean",
"description": "Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. level: extended"
},
"valid": {
"type": "boolean",
"description": "Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. level: extended"
},
"thumbprint_sha1": {
"type": "string",
"description": "Certificate SHA-1 hash that uniquely identifies the code signer. level: extended"
}
},
"hash": {
"$ref": "v8Hash",
"description": "Hashes, usually file hashes. The hash fields represent different bitwise hash algorithms and their values. Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for other hashes by lowercasing the hash algorithm name and using underscore separators as appropriate (snake case, e.g. sha3_512). Note that this fieldset is used for common hashes that may be computed over a range of generic bytes. Entity-specific hashes such as ja3 or imphash are placed in the fieldsets to which they relate (tls and pe, respectively). expected presence: - file - process - dll - email.attachments.file",
"md5": {
"type": "string",
"description": "MD5 hash. level: extended"
},
"sha1": {
"type": "string",
"description": "SHA1 hash. level: extended"
},
"sha256": {
"type": "string",
"description": "SHA256 hash. level: extended"
}
},
"interactive": {
"type": "boolean",
"description": "Whether the process is connected to an interactive shell. Process interactivity is inferred from the processes file descriptors. If the character device for the controlling tty is the same as stdin and stderr for the process, the process is considered interactive. Note: A non-interactive process can belong to an interactive session and is simply one that does not have open file descriptors reading the controlling TTY on FD 0 (stdin) or writing to the controlling TTY on FD 2 (stderr). A backgrounded process is still considered interactive if stdin and stderr are connected to the controlling TTY. level: extended"
}
},
"interactive": {
"type": "boolean",
"description": "Whether the process is connected to an interactive shell. Process interactivity is inferred from the processes file descriptors. If the character device for the controlling tty is the same as stdin and stderr for the process, the process is considered interactive. Note: A non-interactive process can belong to an interactive session and is simply one that does not have open file descriptors reading the controlling TTY on FD 0 (stdin) or writing to the controlling TTY on FD 2 (stderr). A backgrounded process is still considered interactive if stdin and stderr are connected to the controlling TTY. level: extended"
}
},
"registry": {
"$ref": "v8Registry",
"hive": {
"type": "string",
"description": "Abbreviated name for the hive. level: core example: 'HKLM'"
},
"key": {
"type": "string",
"description": "Hive-relative path of keys. level: core example: 'SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\winword.exe'"
},
"path": {
"title": "Full path, including hive, key and value",
"type": "string",
"description": "level: core example: 'HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\winword.exe\Debugger'"
},
"value": {
"type": "string",
"description": "Name of the value written. level: core example: 'Debugger'"
},
"data": {
"$ref": "RegistryRegistryData",
"bytes": {
"type": "string",
"description": "Original bytes written with base64 encoding. For Windows registry operations, such as SetValueEx and RegQueryValueEx, this corresponds to the data pointed by lp_data. This is optional but provides better recoverability and should be populated for REG_BINARY encoded values. level: extended example: 'ZQBuAC0AVQBTAAAAZQBuAAAAAAA='"
},
"strings": [
{
"type": "string"
}
],
"type": {
"title": "Standard registry type for encoding contents",
"type": "string",
"description": "level: core example: 'REG_SZ'"
}
}
},
"related": {
"$ref": "v8Related",
"description": "This field set is meant to facilitate pivoting around a piece of data. Some pieces of information can be seen in many places in an ECS event. To facilitate searching for them, store an array of all seen values to their corresponding field in related.. A concrete example is IP addresses, which can be under host, observer, source, destination, client, server, and network.forwarded_ip. If you append all IPs to related.ip, you can then search for a given IP trivially, no matter where it appeared, by querying related.ip:192.0.2.15.",
"hash": [
{
"type": "string"
}
],
"hosts": [
{
"type": "string"
}
],
"ip": [
{
"type": "string"
}
],
"user": [
{
"type": "string"
}
]
},
"source": {
"$ref": "v8Source",
"description": "Fields about the source side of a network connection, used with destination. Source fields capture details about the sender of a network exchange/packet. These fields are populated from a network event, packet, or other event containing details of a network transaction. Source fields are usually populated in conjunction with destination fields. The source and destination fields are considered the baseline and should always be filled if an event contains source and destination details from a network transaction. If the event also contains identification of the client and server roles, then the client and server fields should also be populated. top_level: true expected presence: - Process.entry_meta.source",
"address": {
"type": "string",
"description": "Source network address. Some event source addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the .address field. Then it should be duplicated to .ip or .domain, depending on which one it is. level: extended"
},
"domain": {
"type": "string",
"description": "The domain name of the source system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. level: core example: foo.example.com"
},
"ip": {
"type": "string",
"description": "IP address of the source (IPv4 or IPv6). level: core"
},
"mac": {
"type": "string",
"description": "MAC address of the source. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. level: core pattern: ^[A-F0-9]{2}(-[A-F0-9]{2}){5,}$ example: 00-00-5E-00-53-23"
},
"port": {
"type": "string",
"description": "Port of the source. level: core",
"format": "int64"
},
"registered_domain": {
"type": "string",
"description": "The highest registered source domain, stripped of the subdomain. For example, the registered domain for 'foo.example.com' is 'example.com'. This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as 'co.uk'. level: extended example: example.com"
},
"subdomain": {
"type": "string",
"description": "The subdomain of the domain. The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of 'www.east.mydomain.co.uk' is 'east'. If the domain has multiple levels of subdomain, such as 'sub2.sub1.example.com', the subdomain field should contain 'sub2.sub1', with no trailing period. level: extended example: east"
},
"top_level_domain": {
"type": "string",
"description": "The effective top level domain (com, org, net, co.uk). The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is 'com'. This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as 'co.uk'. level: extended example: co.uk"
},
"geo": {
"$ref": "v8Geo",
"description": "Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied. Note also that the geo fields are not expected to be used directly at the root of the events.",
"city_name": {
"type": "string",
"description": "City name. level: core example: Montreal"
},
"continent_code": {
"type": "string",
"description": "Two-letter code representing continent's name. level: core example: NA"
},
"continent_name": {
"type": "string",
"description": "Name of the continent. level: core example: North America"
},
"country_iso_code": {
"type": "string",
"description": "Country ISO code. level: core example: CA"
},
"country_name": {
"type": "string",
"description": "Country name. level: core example: Canada"
},
"location": {
"type": "string",
"description": "Longitude and latitude. level: core example: { 'lon': -73.614830, 'lat': 45.505918 }"
},
"name": {
"type": "string",
"description": "User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. level: extended example: boston-dc"
},
"postal_code": {
"type": "string",
"description": "Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. level: core example: 94040"
},
"region_iso_code": {
"type": "string",
"description": "Region ISO code. level: core example: CA-QC"
},
"region_name": {
"type": "string",
"description": "Region name. level: core example: Quebec"
},
"timezone": {
"type": "string",
"description": "The time zone of the location, such as IANA time zone name. level: core example: America/Argentina/Buenos_Aires"
}
},
"as": {
"$ref": "v8As",
"description": "An autonomous system (AS) is a collection of connected Internet Protocol (IP) routing prefixes under the control of one or more network operators on behalf of a single administrative entity or domain that presents a common, clearly defined routing policy to the internet.",
"number": {
"type": "string",
"description": "Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. level: extended example: 15169",
"format": "int64"
},
"organization": {
"$ref": "AsOrganization",
"description": "Object containing information about the owner of autonomous system.",
"name": {
"type": "string",
"description": "Organization name. level: extended example: Google LLC"
}
}
},
"nat": {
"$ref": "v8SourceNat",
"ip": {
"title": "Translated ip of source based NAT sessions (e.g. internal client to internet)",
"type": "string",
"description": "Typically connections traversing load balancers, firewalls, or routers. level: extended"
},
"port": {
"title": "Translated port of source based NAT sessions. (e.g. internal client to internet)",
"type": "string",
"description": "Typically used with load balancers, firewalls, or routers. level: extended",
"format": "int64"
}
},
"user": {
"$ref": "v8SourceUserReference",
"description": "Fields to describe the source user relevant to the event.",
"domain": {
"type": "string",
"description": "Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"email": {
"type": "string",
"description": "User email address. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier of the user. level: core example: S-1-5-21-202424912787-2692429404-2351956786-1000"
},
"name": {
"type": "string",
"description": "Short name or login of the user. level: core example: a.einstein"
},
"full_name": {
"type": "string",
"description": "User’s full name, if available. level: core example: Albert Einstein"
}
}
},
"@timestamp": {
"type": "string",
"description": "Date/time when the event originated. This is the date/time extracted from the event, typically representing when the event was generated by the source. If the event source has no original timestamp, this value is typically populated by the first time the event was received by the pipeline. Required field for all events. level: core example: 2016-05-23T08:05:34.853Z",
"format": "date-time"
},
"threat": {
"$ref": "v8Threat",
"description": "Fields to classify events and alerts according to a threat taxonomy such as the MITRE ATT&CK® framework. These fields are for users to classify alerts from all of their sources (e.g. IDS, NGFW, etc.) within a common taxonomy. The threat.tactic.* fields are meant to capture the high level category of the threat (e.g. 'impact'). The threat.technique.* fields are meant to capture which kind of approach is used by this detected threat, to accomplish the goal (e.g. 'endpoint denial of service').",
"enrichments": [
{
"$ref": "ThreatEnrichments",
"description": "Threat intelligence indicator object enriching the event, and the context of that association/enrichment.",
"indicator": {
"$ref": "v8ThreatIndicator",
"confidence": {
"type": "string",
"description": "Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. allowed_values: - Not Specified - None - Low - Medium - High level: extended example: Medium"
},
"description": {
"type": "string",
"description": "Describes the type of action conducted by the threat. level: extended example: IP x.x.x.x was observed delivering the Angler EK."
},
"email": {
"$ref": "ThreatIndicatorEmail",
"address": {
"type": "string",
"description": "Identifies a threat indicator as an email address (irrespective of direction). level: extended example: phish@example.com"
}
},
"first_seen": {
"type": "string",
"description": "The date and time when intelligence source first reported sighting this indicator. level: extended example: 2020-11-05T17:25:47.000Z",
"format": "date-time"
},
"id": [
{
"type": "string"
}
],
"ip": {
"type": "string",
"description": "Identifies a threat indicator as an IP address (irrespective of direction). level: extended example: 1.2.3.4"
},
"last_seen": {
"type": "string",
"description": "The date and time when intelligence source last reported sighting this indicator. level: extended example: 2020-11-05T17:25:47.000Z",
"format": "date-time"
},
"marking": {
"$ref": "IndicatorMarking",
"tlp": {
"type": "string",
"description": "Traffic Light Protocol sharing markings. allowed_values: - WHITE - CLEAR - GREEN - AMBER - AMBER+STRICT - RED level: extended example: CLEAR"
},
"tlp_version": {
"type": "string",
"description": "Traffic Light Protocol version. level: extended example: 2.0"
}
},
"modified_at": {
"type": "string",
"description": "The date and time when intelligence source last modified information for this indicator. level: extended example: 2020-11-05T17:25:47.000Z",
"format": "date-time"
},
"name": {
"title": "The display name indicator in an UI friendly format",
"type": "string",
"description": "URL, IP address, email address, registry key, port number, hash value, or other relevant name can serve as the display name. level: extended example: 5.2.75.227"
},
"port": {
"type": "string",
"description": "Identifies a threat indicator as a port number (irrespective of direction). level: extended example: 443",
"format": "int64"
},
"provider": {
"type": "string",
"description": "The name of the indicator’s provider. level: extended example: lrz_urlhaus"
},
"reference": {
"type": "string",
"description": "Reference URL linking to additional information about this indicator. level: extended example: https://system.example.com/indicator/0001234"
},
"scanner_stats": {
"type": "string",
"description": "Count of AV/EDR vendors that successfully detected malicious file or URL. level: extended example: 4",
"format": "int64"
},
"sightings": {
"type": "string",
"description": "Number of times this indicator was observed conducting threat activity. level: extended example: 20",
"format": "int64"
},
"type": {
"type": "string",
"description": "Type of indicator as represented by Cyber Observable in STIX 2.0. allowed_values: - autonomous-system - artifact - directory - domain-name - email-addr - file - ipv4-addr - ipv6-addr - mac-addr - mutex - port - process - software - url - user-account - windows-registry-key - x509-certificate level: extended example: ipv4-addr"
},
"geo": {
"$ref": "v8Geo",
"description": "Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied. Note also that the geo fields are not expected to be used directly at the root of the events.",
"city_name": {
"type": "string",
"description": "City name. level: core example: Montreal"
},
"continent_code": {
"type": "string",
"description": "Two-letter code representing continent's name. level: core example: NA"
},
"continent_name": {
"type": "string",
"description": "Name of the continent. level: core example: North America"
},
"country_iso_code": {
"type": "string",
"description": "Country ISO code. level: core example: CA"
},
"country_name": {
"type": "string",
"description": "Country name. level: core example: Canada"
},
"location": {
"type": "string",
"description": "Longitude and latitude. level: core example: { 'lon': -73.614830, 'lat': 45.505918 }"
},
"name": {
"type": "string",
"description": "User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. level: extended example: boston-dc"
},
"postal_code": {
"type": "string",
"description": "Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. level: core example: 94040"
},
"region_iso_code": {
"type": "string",
"description": "Region ISO code. level: core example: CA-QC"
},
"region_name": {
"type": "string",
"description": "Region name. level: core example: Quebec"
},
"timezone": {
"type": "string",
"description": "The time zone of the location, such as IANA time zone name. level: core example: America/Argentina/Buenos_Aires"
}
},
"as": {
"$ref": "v8As",
"description": "An autonomous system (AS) is a collection of connected Internet Protocol (IP) routing prefixes under the control of one or more network operators on behalf of a single administrative entity or domain that presents a common, clearly defined routing policy to the internet.",
"number": {
"type": "string",
"description": "Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. level: extended example: 15169",
"format": "int64"
},
"organization": {
"$ref": "AsOrganization",
"description": "Object containing information about the owner of autonomous system.",
"name": {
"type": "string",
"description": "Organization name. level: extended example: Google LLC"
}
}
}
},
"matched": {
"$ref": "ThreatMatched",
"atomic": {
"type": "string",
"description": "Identifies the atomic indicator value that matched a local environment endpoint or network event. level: extended example: bad-domain.com"
},
"field": {
"type": "string",
"description": "Identifies the field of the atomic indicator that matched a local environment endpoint or network event. level: extended example: file.hash.sha256"
},
"id": {
"type": "string",
"description": "Identifies the _id of the indicator document enriching the event. level: extended example: ff93aee5-86a1-4a61-b0e6-0cdc313d01b5"
},
"index": {
"type": "string",
"description": "Identifies the _index of the indicator document enriching the event. level: extended example: filebeat-8.0.0-2021.05.23-000011"
},
"occurred": {
"title": "Indicates when the indicator match was generated",
"type": "string",
"description": "level: extended example: 2021-10-05T17:00:58.326Z",
"format": "date-time"
},
"type": {
"type": "string",
"description": "Identifies the type of match that caused the event to be enriched with the given indicator. level:extended example: indicator_match_rule"
}
}
}
],
"feed": {
"$ref": "ThreatFeed",
"dashboard_id": {
"type": "string",
"description": "The saved object ID of the dashboard belonging to the threat feed for displaying dashboard links to threat feeds in Kibana. level: extended example: 5ba16340-72e6-11eb-a3e3-b3cc7c78a70f"
},
"description": {
"type": "string",
"description": "Description of the threat feed in a UI friendly format. level: extended example: Threat feed from the AlienVault Open Threat eXchange network."
},
"name": {
"type": "string",
"description": "The name of the threat feed in UI friendly format. level: extended example: AlienVault OTX"
},
"reference": {
"type": "string",
"description": "Reference information for the threat feed in a UI friendly format. level: extended example: https://otx.alienvault.com"
}
},
"framework": {
"type": "string",
"description": "Name of the threat framework used to further categorize and classify the tactic and technique of the reported threat. Framework classification can be provided by detecting systems, evaluated at ingest time, or retrospectively tagged to events. level: extended example: MITRE ATT&CK"
},
"group": {
"$ref": "v8ThreatGroup",
"alias": [
{
"type": "string"
}
],
"id": {
"type": "string",
"description": "The id of the group for a set of related intrusion activity that are tracked by a common name in the security community. While not required, you can use a MITRE ATT&CK® group id. level: extended example: G0037"
},
"name": {
"type": "string",
"description": "The name of the group for a set of related intrusion activity that are tracked by a common name in the security community. While not required, you can use a MITRE ATT&CK® group name. level: extended example: FIN6"
},
"reference": {
"type": "string",
"description": "The reference URL of the group for a set of related intrusion activity that are tracked by a common name in the security community. While not required, you can use a MITRE ATT&CK® group reference URL. level: extended example: https://attack.mitre.org/groups/G0037/"
}
},
"indicator": {
"$ref": "v8ThreatIndicator",
"confidence": {
"type": "string",
"description": "Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. allowed_values: - Not Specified - None - Low - Medium - High level: extended example: Medium"
},
"description": {
"type": "string",
"description": "Describes the type of action conducted by the threat. level: extended example: IP x.x.x.x was observed delivering the Angler EK."
},
"email": {
"$ref": "ThreatIndicatorEmail",
"address": {
"type": "string",
"description": "Identifies a threat indicator as an email address (irrespective of direction). level: extended example: phish@example.com"
}
},
"first_seen": {
"type": "string",
"description": "The date and time when intelligence source first reported sighting this indicator. level: extended example: 2020-11-05T17:25:47.000Z",
"format": "date-time"
},
"id": [
{
"type": "string"
}
],
"ip": {
"type": "string",
"description": "Identifies a threat indicator as an IP address (irrespective of direction). level: extended example: 1.2.3.4"
},
"last_seen": {
"type": "string",
"description": "The date and time when intelligence source last reported sighting this indicator. level: extended example: 2020-11-05T17:25:47.000Z",
"format": "date-time"
},
"marking": {
"$ref": "IndicatorMarking",
"tlp": {
"type": "string",
"description": "Traffic Light Protocol sharing markings. allowed_values: - WHITE - CLEAR - GREEN - AMBER - AMBER+STRICT - RED level: extended example: CLEAR"
},
"tlp_version": {
"type": "string",
"description": "Traffic Light Protocol version. level: extended example: 2.0"
}
},
"modified_at": {
"type": "string",
"description": "The date and time when intelligence source last modified information for this indicator. level: extended example: 2020-11-05T17:25:47.000Z",
"format": "date-time"
},
"name": {
"title": "The display name indicator in an UI friendly format",
"type": "string",
"description": "URL, IP address, email address, registry key, port number, hash value, or other relevant name can serve as the display name. level: extended example: 5.2.75.227"
},
"port": {
"type": "string",
"description": "Identifies a threat indicator as a port number (irrespective of direction). level: extended example: 443",
"format": "int64"
},
"provider": {
"type": "string",
"description": "The name of the indicator’s provider. level: extended example: lrz_urlhaus"
},
"reference": {
"type": "string",
"description": "Reference URL linking to additional information about this indicator. level: extended example: https://system.example.com/indicator/0001234"
},
"scanner_stats": {
"type": "string",
"description": "Count of AV/EDR vendors that successfully detected malicious file or URL. level: extended example: 4",
"format": "int64"
},
"sightings": {
"type": "string",
"description": "Number of times this indicator was observed conducting threat activity. level: extended example: 20",
"format": "int64"
},
"type": {
"type": "string",
"description": "Type of indicator as represented by Cyber Observable in STIX 2.0. allowed_values: - autonomous-system - artifact - directory - domain-name - email-addr - file - ipv4-addr - ipv6-addr - mac-addr - mutex - port - process - software - url - user-account - windows-registry-key - x509-certificate level: extended example: ipv4-addr"
},
"geo": {
"$ref": "v8Geo",
"description": "Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied. Note also that the geo fields are not expected to be used directly at the root of the events.",
"city_name": {
"type": "string",
"description": "City name. level: core example: Montreal"
},
"continent_code": {
"type": "string",
"description": "Two-letter code representing continent's name. level: core example: NA"
},
"continent_name": {
"type": "string",
"description": "Name of the continent. level: core example: North America"
},
"country_iso_code": {
"type": "string",
"description": "Country ISO code. level: core example: CA"
},
"country_name": {
"type": "string",
"description": "Country name. level: core example: Canada"
},
"location": {
"type": "string",
"description": "Longitude and latitude. level: core example: { 'lon': -73.614830, 'lat': 45.505918 }"
},
"name": {
"type": "string",
"description": "User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. level: extended example: boston-dc"
},
"postal_code": {
"type": "string",
"description": "Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. level: core example: 94040"
},
"region_iso_code": {
"type": "string",
"description": "Region ISO code. level: core example: CA-QC"
},
"region_name": {
"type": "string",
"description": "Region name. level: core example: Quebec"
},
"timezone": {
"type": "string",
"description": "The time zone of the location, such as IANA time zone name. level: core example: America/Argentina/Buenos_Aires"
}
},
"as": {
"$ref": "v8As",
"description": "An autonomous system (AS) is a collection of connected Internet Protocol (IP) routing prefixes under the control of one or more network operators on behalf of a single administrative entity or domain that presents a common, clearly defined routing policy to the internet.",
"number": {
"type": "string",
"description": "Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. level: extended example: 15169",
"format": "int64"
},
"organization": {
"$ref": "AsOrganization",
"description": "Object containing information about the owner of autonomous system.",
"name": {
"type": "string",
"description": "Organization name. level: extended example: Google LLC"
}
}
}
},
"software": {
"$ref": "ThreatSoftware",
"id": {
"type": "string",
"description": "The id of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. While not required, you can use a MITRE ATT&CK® software id. level: extended: example: S0552"
},
"name": {
"type": "string",
"description": "The name of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. While not required, you can use a MITRE ATT&CK® software name. level: extended example: AdFind"
},
"platforms": [
{
"type": "string"
}
],
"reference": {
"type": "string",
"description": "The reference URL of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. While not required, you can use a MITRE ATT&CK® software reference URL. level: extended example: https://attack.mitre.org/software/S0552/"
},
"type": {
"type": "string",
"description": "The type of software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. While not required, you can use a MITRE ATT&CK® software type. allowed_values: - Malware - Tools level: extended example: Tool"
}
},
"tactic": {
"$ref": "ThreatTactic",
"id": [
{
"type": "string"
}
],
"name": [
{
"type": "string"
}
],
"reference": [
{
"type": "string"
}
]
},
"technique": {
"$ref": "ThreatTechnique",
"id": [
{
"type": "string"
}
],
"name": [
{
"type": "string"
}
],
"reference": [
{
"type": "string"
}
],
"subtechnique": [
{
"$ref": "ThreatSubTechnique",
"id": [
{
"type": "string"
}
],
"name": [
{
"type": "string"
}
],
"reference": [
{
"type": "string"
}
]
}
]
}
},
"rule": {
"$ref": "v8Rule",
"description": {
"title": "Rule description",
"type": "string",
"description": "The description of the rule generating the event. level: extended example: 'Block requests to public DNS over HTTPS / TLS protocols' example: cmd.exe (command line interpreter) was executed, but the name of the file was renamed. It can be used to disguise the execution of malicious scripts or commands."
},
"author": [
{
"type": "string"
}
],
"category": {
"title": "Rule category",
"type": "string",
"description": "A categorization value keyword used by the entity using the rule for detection of this event. level: extended example: Attempted Information Leak example: Suspicious Process Creation and Process Manipulation"
},
"id": {
"title": "Rule ID",
"type": "string",
"description": "A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event. level: extended example: B0404"
},
"license": {
"title": "Rule license",
"type": "string",
"description": "Name of the license under which the rule used to generate this event is made available. level: extended example: Apache 2.0"
},
"name": {
"title": "Rule name",
"type": "string",
"description": "The name of the rule or signature generating the event. level: extended example: BLOCK_DNS_over_TLS example: cmd.exe executed under a different name [B0404][C]"
},
"reference": {
"title": "Rule reference",
"type": "string",
"description": "Reference URL to additional information about the rule used to generate this event. The URL can point to the vendor's documentation about the rule. If that's not available, it can also be a link to a more general page describing this type of alert. level: extended example: https://en.wikipedia.org/wiki/DNS_over_TLS"
},
"ruleset": {
"title": "Rule ruleset",
"type": "string",
"description": "Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member. level: extended example: Standard_Protocol_Filters"
},
"version": {
"title": "Rule version",
"type": "string",
"description": "The version / revision of the rule being used for analysis. level: extended example: 1.1"
},
"uuid": {
"title": "Rule UUID",
"type": "string",
"description": "A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event. level: extended example: 1100110011 example: 351cdb2f-dd96-4b41-ae9e-2db50a3edcea"
}
},
"url": {
"$ref": "v8Url",
"description": "Fields that let you store URLs in various forms. URL fields provide support for complete or partial URLs, and supports the breaking down into scheme, domain, path, and so on. top_level: true expected presence: - Threat.indicator.url - Threat.enrichments.indicator.url",
"domain": {
"type": "string",
"description": "Domain of the url. Domain of the url, such as 'www.elastic.co'. In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the domain field. If the URL contains a literal IPv6 address enclosed by [ and ] (IETF RFC 2732), the [ and ] characters should also be captured in the domain field. level: extended example: www.elastic.co"
},
"extension": {
"type": "string",
"description": "File extension from the request url, excluding the leading dot. The field contains the file extension from the original request url, excluding the leading dot. The file extension is only set if it exists, as not every url has a file extension. The leading period must not be included. For example, the value must be 'png', not '.png'. Note that when the file name has multiple extensions (example.tar.gz), only the last one should be captured ('gz', not 'tar.gz'). level: extended example: png"
},
"fragment": {
"type": "string",
"description": "Portion of the url after the #, such as 'top'. The # is not part of the fragment. level: extended example: top"
},
"full": {
"type": "string",
"description": "Full unparsed URL. If full URLs are important to your use case, they should be stored in url.full, whether this field is reconstructed or present in the event source. level: extended example: https://www.elastic.co:443/search?q=elasticsearch#top"
},
"original": {
"type": "string",
"description": "Unmodified original url as seen in the event source. Note that in network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path. This field is meant to represent the URL as it was observed, complete or not. level: extended example: https://www.elastic.co:443/search?q=elasticsearch#top or /search?q=elasticsearch"
},
"password": {
"type": "string",
"description": "Password of the request. level: extended example: nbusr123"
},
"path": {
"type": "string",
"description": "Path of the request, such as '/search'. level: extended example: /search"
},
"port": {
"type": "string",
"description": "Port of the request, such as 443. level: extended example: 443",
"format": "int64"
},
"query": {
"type": "string",
"description": "Query string of the request. The query field describes the query string of the request, such as 'q=elasticsearch'. The ? is excluded from the query string. If a URL contains no ?, there is no query field. If there is a ? but no query, the query field exists with an empty string. The exists query can be used to differentiate between the two cases. level: extended"
},
"registered_domain": {
"type": "string",
"description": "The highest registered url domain, stripped of the subdomain. For example, the registered domain for 'foo.example.com' is 'example.com'. This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as 'co.uk'. level: extended example: example.com"
},
"scheme": {
"type": "string",
"description": "Scheme of the url. Scheme of the request, such as 'https'. Note: The : is not part of the scheme. level: extended example: https"
},
"subdomain": {
"type": "string",
"description": "The subdomain of the domain. The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of 'www.east.mydomain.co.uk' is 'east'. If the domain has multiple levels of subdomain, such as 'sub2.sub1.example.com', the subdomain field should contain 'sub2.sub1', with no trailing period. level: extended example: east"
},
"top_level_domain": {
"type": "string",
"description": "The effective top level domain (com, org, net, co.uk). The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is 'com'. This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as 'co.uk'. example: co.uk level: extended"
},
"username": {
"type": "string",
"description": "Username of the request. level: extended example: admin"
}
},
"user": {
"$ref": "ecsv8User",
"description": "Fields to describe the user relevant to the event. The user fields describe information about the user that is relevant to the event. Fields can have one entry or multiple entries. If a user has more than one id, provide an array that includes all of them. expected presence: - client - destination - server - source.user.target - user.effective - user.changes - process.user - process.saved_user - process.real_user - process.attested_user",
"domain": {
"type": "string",
"description": "Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"email": {
"type": "string",
"description": "User email address. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier of the user. level: core example: S-1-5-21-202424912787-2692429404-2351956786-1000"
},
"name": {
"type": "string",
"description": "Short name or login of the user. level: core example: a.einstein"
},
"full_name": {
"type": "string",
"description": "User’s full name, if available. level: core example: Albert Einstein"
},
"target": {
"$ref": "v8UserUserReference",
"domain": {
"type": "string",
"description": "Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier of the user. level: core example: S-1-5-21-202424912787-2692429404-2351956786-1000"
},
"name": {
"type": "string",
"description": "Short name or login of the user. level: core example: a.einstein"
},
"full_name": {
"type": "string",
"description": "User’s full name, if available. level: core example: Albert Einstein"
}
},
"group": {
"$ref": "ecsv8Group",
"description": "The group fields are meant to represent groups that are relevant to the event.",
"domain": {
"type": "string",
"description": "Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier for the group on the system/platform. level: extended"
},
"name": {
"type": "string",
"description": "Name of the group. level: extended"
}
},
"changes": {
"$ref": "v8UserUserReference",
"domain": {
"type": "string",
"description": "Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. level: extended"
},
"id": {
"type": "string",
"description": "Unique identifier of the user. level: core example: S-1-5-21-202424912787-2692429404-2351956786-1000"
},
"name": {
"type": "string",
"description": "Short name or login of the user. level: core example: a.einstein"
},
"full_name": {
"type": "string",
"description": "User’s full name, if available. level: core example: Albert Einstein"
}
}
},
"user_agent": {
"$ref": "v8UserAgent",
"description": "The user_agent fields normally come from a browser request. They often show up in web service logs coming from the parsed user agent string. Or they can also show up in logs from Cloud environments.",
"name": {
"type": "string",
"description": "Name of the user agent. type: keyword example: Safari"
},
"original": {
"type": "string",
"description": "Unparsed user_agent string. type: keyword Multi-fields: user_agent.original.text (type: match_only_text) example: Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1"
},
"version": {
"type": "string",
"description": "Version of the user agent. type: keyword example: 12.0"
},
"device": {
"$ref": "v8UserAgentDevice",
"description": "Device related information parsed form User-agent string.",
"name": {
"type": "string",
"description": "Name of the device. type: keyword example: iPhone"
}
}
},
"volume": {
"$ref": "v8Volume",
"description": "Fields related to storage volume details.",
"bus_type": {
"type": "string",
"description": "Bus type of the device, such as Nvme, Usb, or FileBackedVirtual. type: keyword example: FileBackedVirtual"
},
"default_access": {
"type": "string",
"description": "Describes the default access(es) of the volume. type: keyword"
},
"device_name": {
"type": "string",
"description": "Full path of the volume device. Only populate this field for POSIX system volumes. type: keyword"
},
"device_type": {
"type": "string",
"description": "Volume device type. The most frequently seen volume device types are Disk File System and CD-ROM File System. type: keyword allowed_values: - CD-ROM File System - Disk File System - Network File System example: CD-ROM File System"
},
"dos_name": {
"type": "string",
"description": "The MS-DOS name of a device. DOS device name is in the format of driver letters, such as C:. The field is relevant to Windows systems only. type: keyword example: E:"
},
"file_system_type": {
"type": "string",
"description": "Volume device file system type. The most common volume file system types are NTFS and UDF. type: keyword"
},
"mount_name": {
"type": "string",
"description": "Mount name of the volume device. Only populate this field for POSIX system volumes. type: keyword"
},
"nt_name": {
"type": "string",
"description": "The NT device name. NT device name uses a format of \Device\HarddiskVolume2. The field is relevant to Windows systems only. type: keyword example: \Device\Cdrom1"
},
"product_id": {
"type": "string",
"description": "ProductID of the device. The vendor provides the ProductID for the volume, if any. type: keyword"
},
"product_name": {
"type": "string",
"description": "Product name of the volume. The volume device vendor provides this value. type: keyword example: Virtual DVD-ROM"
},
"removable": {
"type": "boolean",
"description": "Indicates if the volume is removable. type: boolean"
},
"serial_number": {
"type": "string",
"description": "Serial number identifier for the volume device. The serial number is provided by the vendor of the device, if any. type: keyword"
},
"size": {
"type": "string",
"description": "Size of the volume device in bytes. type: long",
"format": "uint64"
},
"vendor_id": {
"type": "string",
"description": "VendorID of the volume device. The volume device vendor provides this value. type: keyword"
},
"vendor_name": {
"type": "string",
"description": "Vendor name of the volume device. The value is provided by the vendor of the device. type: keyword"
},
"writable": {
"type": "boolean",
"description": "Indicates if the volume is writable. type: boolean"
}
}
}
],
"nextPageToken": {
"type": "string",
"description": "Page token of the next page. Empty or '' for the last page. Info: For more information, refer to Paginating Requests in APIs or Design Patterns: Pagination"
}
}
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
202 |
Response took too long; request cached. Response can be retrieved later using the response-id header. |
Response took too long; request cached. Response can be retrieved later using the response-id header.
[]
{
"response-id": {
"description": "Unique ID of a pending request. Used to retrieve cached result.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
400 |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided. |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
401 |
Token has expired or is invalid. |
Token has expired or is invalid.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
403 |
Access denied. Check permissions. |
Access denied. Check permissions.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
404 |
Requested resource not found. |
Requested resource not found.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
429 |
Rate limit reached. Try again later. |
Rate limit reached. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
500 |
Internal server failure. Try again later. |
Internal server failure. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
502 |
Internal server failure. Try again later. |
Internal server failure. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
503 |
Environment under maintenance. Try again later. |
Environment under maintenance. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
504 |
Action took too long; timeout reached |
Action took too long; timeout reached
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|