Chris Moore 49e8391d86
Add documentation for OCSF field mapping and correlation engine API (#4549)
* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* add missing param descriptions (#4555)

Signed-off-by: Subhobrata Dey <sbcd90@gmail.com>

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* Revert "fix#4500 ocsf fields and api"

This reverts commit c6db296b2e30dd9e201cdf510d77e1af7335801d.

merge conflict with same edits on another branch#

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* Revert "fix#4500 ocsf fields and api"

This reverts commit 7a70dc39644b5020685015245d755131c2264e03.

merge conflict with second branch
:wq

* Revert "fix#4500 ocsf fields and api"

This reverts commit ef13a74b403984e0c205a79119ec301f90b7dcc1.

* fix#4500 edits post merge conflict

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#4500 ocsf fields and api

Signed-off-by: cwillum <cwmmoore@amazon.com>

---------

Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: Subhobrata Dey <sbcd90@gmail.com>
Co-authored-by: Subhobrata Dey <sbcd90@gmail.com>
2023-07-17 13:52:13 -07:00

23 lines
988 B
Markdown

---
layout: default
title: API tools
nav_order: 30
has_children: true
has_toc: false
redirect_from:
- /security-analytics/api-tools/
---
# API tools
Security Analytics includes a number of APIs to help administrators maintain and update an implementation. The APIs often mimic the same controls available for setting up Security Analytics in OpenSearch Dashboards, and they provide another option for administering the plugin.
The APIs for Security Analytics are separated into the following categories:
* [Detector APIs]({{site.url}}{{site.baseurl}}/security-analytics/api-tools/detector-api/)
* [Rules APIs]({{site.url}}{{site.baseurl}}/security-analytics/api-tools/rule-api/)
* [Mappings APIs]({{site.url}}{{site.baseurl}}/security-analytics/api-tools/mappings-api/)
* [Alerts and findings APIs]({{site.url}}{{site.baseurl}}/security-analytics/api-tools/alert-finding-api/)
* [Correlation engine APIs]({{site.url}}{{site.baseurl}}/security-analytics/api-tools/correlation-eng/)