diff --git a/docs/api-document-lookup.md b/docs/api-document-lookup.md index 2fb0a5bb4..6aadb1e68 100644 --- a/docs/api-document-lookup.md +++ b/docs/api-document-lookup.md @@ -20,7 +20,7 @@ $ curl -k -u username -L -XPOST -H 'Content-Type: application/json' \ -d '{"limit": 10, filter":{"zeek.uid":"CYeji2z7CKmPRGyga"}}' ``` -```json +``` { "filter": { "zeek.uid": "CYeji2z7CKmPRGyga" diff --git a/docs/api-event-logging.md b/docs/api-event-logging.md index ad591f2a6..fb68055eb 100644 --- a/docs/api-event-logging.md +++ b/docs/api-event-logging.md @@ -7,7 +7,7 @@ A webhook that accepts alert data to be reindexed into OpenSearch as session rec
Example input: -```json +``` { "alert": { "monitor": { @@ -52,7 +52,7 @@ A webhook that accepts alert data to be reindexed into OpenSearch as session rec
Example output: -```json +``` { "_index": "arkime_sessions3-220308", "_type": "_doc", diff --git a/docs/api-examples.md b/docs/api-examples.md index f86026027..2eb40a363 100644 --- a/docs/api-examples.md +++ b/docs/api-examples.md @@ -9,7 +9,7 @@ Some security-related API examples: /mapi/agg/network.type,network.transport,network.protocol,network.protocol_version ``` -```json +``` { "fields": [ "network.type", @@ -389,7 +389,7 @@ Some security-related API examples: /mapi/agg/zeek.software.name,zeek.software.unparsed_version ``` -```json +``` { "fields": [ "zeek.software.name", @@ -785,7 +785,7 @@ Some security-related API examples: /mapi/agg/user_agent.original ``` -```json +``` { "fields": [ "user_agent.original" @@ -889,7 +889,7 @@ $ curl -k -u username -L -XPOST -H 'Content-Type: application/json' \ -d '{"filter":{"network.direction":["inbound","outbound"]}}' ``` -```json +``` { "fields": [ "network.protocol" @@ -949,7 +949,7 @@ $ curl -k -u username -L -XPOST -H 'Content-Type: application/json' \ -d '{"filter":{"tags":"cross_segment"}}' ``` -```json +``` { "fields": [ "source.segment", @@ -1132,7 +1132,7 @@ $ curl -k -u username -L -XPOST -H 'Content-Type: application/json' \ -d '{"filter":{"!related.password":null}}' ``` -```json +``` { "fields": [ "network.protocol" @@ -1169,7 +1169,7 @@ $ curl -k -u username -L -XPOST -H 'Content-Type: application/json' \ -d '{"filter":{"event.severity_tags":"Insecure or outdated protocol"}}' ``` -```json +``` { "fields": [ "network.protocol", @@ -1251,7 +1251,7 @@ $ curl -k -u username -L -XPOST -H 'Content-Type: application/json' \ /mapi/agg/zeek.notice.category,zeek.notice.sub_category ``` -```json +``` { "fields": [ "zeek.notice.category", @@ -1362,7 +1362,7 @@ $ curl -k -u username -L -XPOST -H 'Content-Type: application/json' \ /mapi/agg/event.severity_tags ``` -```json +``` { "fields": [ "event.severity_tags" diff --git a/docs/api-fields.md b/docs/api-fields.md index 00679476c..51a0ac3bc 100644 --- a/docs/api-fields.md +++ b/docs/api-fields.md @@ -7,7 +7,7 @@ Returns the (very long) list of fields known to Malcolm, comprised of data from
Example output: -```json +``` { "fields": { "@timestamp": { diff --git a/docs/api-indices.md b/docs/api-indices.md index fc0a7cd3f..f5bb416ca 100644 --- a/docs/api-indices.md +++ b/docs/api-indices.md @@ -7,7 +7,7 @@ Lists [information related to the underlying OpenSearch indices](https://opensea
Example output: -```json +``` { "indices": [ … diff --git a/docs/api-ping.md b/docs/api-ping.md index 28fd70de1..75dc67070 100644 --- a/docs/api-ping.md +++ b/docs/api-ping.md @@ -6,6 +6,6 @@ Returns `pong` (for a simple "up" check). Example output: -```json +``` {"ping":"pong"} ``` \ No newline at end of file diff --git a/docs/api-version.md b/docs/api-version.md index a0490300c..bbfabffe3 100644 --- a/docs/api-version.md +++ b/docs/api-version.md @@ -7,7 +7,7 @@ Returns version information about Malcolm and version/[health](https://opensearc
Example output: -```json +``` { "built": "2022-01-18T16:10:39Z", "opensearch": { diff --git a/docs/api.md b/docs/api.md index f5434d71c..96aca5467 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,9 +1,8 @@ # API -* [Aggregations](api-aggregations.md) -* [Document](api-document-lookup.md) -* [Event](api-event-logging.md) -* [Examples](api-examples.md) +* [Field Aggregations](api-aggregations.md) +* [Document Lookup](api-document-lookup.md) +* [Event Logging](api-event-logging.md) * [Fields](api-fields.md) * [Indices](api-indices.md) * [Ping](api-ping.md)