Skip to content

Commit

Permalink
Update mappings-api.md (#4692)
Browse files Browse the repository at this point in the history
Signed-off-by: kolchfa-aws <[email protected]>
  • Loading branch information
kolchfa-aws authored and vagimeli committed Dec 20, 2023
1 parent 06320f3 commit d9939a5
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions _security-analytics/api-tools/mappings-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,18 @@ The following APIs can be used for a number of tasks related to mappings, from c
---
## Get Mappings View


this API returns a view of the fields contained in an index used as a log source.
This API returns a view of the fields contained in an index used as a log source.

### Request fields

The following fields are used to get field mappings.

Field | Type | Description
:--- | :--- |:--- |
| `index_name` | String | The name of the index used for log ingestion. |
| `rule_topic` | String | The log type of the index. |
:--- | :--- |:---
`index_name` | String | The name of the index used for log ingestion.
`rule_topic` | String | The log type of the index.

### Example request
#### Example request

```json
GET /_plugins/_security_analytics/mappings/view
Expand All @@ -35,7 +34,7 @@ GET /_plugins/_security_analytics/mappings/view
}
```

### Example response
#### Example response

```json
{
Expand Down Expand Up @@ -79,7 +78,7 @@ GET /_plugins/_security_analytics/mappings/view
---
## Create Mappings

### Example request
#### Example request

```json
POST /_plugins/_security_analytics/mappings
Expand All @@ -99,7 +98,7 @@ POST /_plugins/_security_analytics/mappings
}
```

### Example response
#### Example response

```json
{
Expand All @@ -110,13 +109,13 @@ POST /_plugins/_security_analytics/mappings
---
## Get Mappings

### Example request
#### Example request

```json
GET /_plugins/_security_analytics/mappings
```

### Example response
#### Example response

```json
{
Expand All @@ -140,7 +139,7 @@ GET /_plugins/_security_analytics/mappings
---
## Update Mappings

### Example request
#### Example request

```json
PUT /_plugins/_security_analytics/mappings
Expand All @@ -152,7 +151,7 @@ PUT /_plugins/_security_analytics/mappings
}
```

### Example response
#### Example response

```json
{
Expand Down

0 comments on commit d9939a5

Please sign in to comment.