Skip to content

Commit

Permalink
experimenting with github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mmguero committed Sep 23, 2022
1 parent 061d2ac commit b85fec2
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/api-document-lookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions docs/api-event-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A webhook that accepts alert data to be reindexed into OpenSearch as session rec
<details>
<summary>Example input:</summary>

```json
```
{
"alert": {
"monitor": {
Expand Down Expand Up @@ -52,7 +52,7 @@ A webhook that accepts alert data to be reindexed into OpenSearch as session rec
<details>
<summary>Example output:</summary>

```json
```
{
"_index": "arkime_sessions3-220308",
"_type": "_doc",
Expand Down
18 changes: 9 additions & 9 deletions docs/api-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Some security-related API examples:
/mapi/agg/network.type,network.transport,network.protocol,network.protocol_version
```

```json
```
{
"fields": [
"network.type",
Expand Down Expand Up @@ -389,7 +389,7 @@ Some security-related API examples:
/mapi/agg/zeek.software.name,zeek.software.unparsed_version
```

```json
```
{
"fields": [
"zeek.software.name",
Expand Down Expand Up @@ -785,7 +785,7 @@ Some security-related API examples:
/mapi/agg/user_agent.original
```

```json
```
{
"fields": [
"user_agent.original"
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -949,7 +949,7 @@ $ curl -k -u username -L -XPOST -H 'Content-Type: application/json' \
-d '{"filter":{"tags":"cross_segment"}}'
```

```json
```
{
"fields": [
"source.segment",
Expand Down Expand Up @@ -1132,7 +1132,7 @@ $ curl -k -u username -L -XPOST -H 'Content-Type: application/json' \
-d '{"filter":{"!related.password":null}}'
```

```json
```
{
"fields": [
"network.protocol"
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion docs/api-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Returns the (very long) list of fields known to Malcolm, comprised of data from
<details>
<summary>Example output:</summary>

```json
```
{
"fields": {
"@timestamp": {
Expand Down
2 changes: 1 addition & 1 deletion docs/api-indices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Lists [information related to the underlying OpenSearch indices](https://opensea
<details>
<summary>Example output:</summary>

```json
```
{
"indices": [
Expand Down
2 changes: 1 addition & 1 deletion docs/api-ping.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Returns `pong` (for a simple "up" check).

Example output:

```json
```
{"ping":"pong"}
```
2 changes: 1 addition & 1 deletion docs/api-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Returns version information about Malcolm and version/[health](https://opensearc
<details>
<summary>Example output:</summary>

```json
```
{
"built": "2022-01-18T16:10:39Z",
"opensearch": {
Expand Down
7 changes: 3 additions & 4 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# <a name="API"></a>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)
Expand Down

0 comments on commit b85fec2

Please sign in to comment.