Skip to content

Commit

Permalink
Merge pull request #687 from logzio/add-api-fetcher-comments
Browse files Browse the repository at this point in the history
API fetcher emphasis it can be customized
  • Loading branch information
8naama authored Oct 20, 2024
2 parents 84f09db + ab3bd5f commit 2aa83a7
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 3 deletions.
4 changes: 4 additions & 0 deletions docs/shipping/Azure/azure-active-directory.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ apis:

```

:::note
You can customize the endpoints to collect data by adding or modifying the configurations under the `apis` section. Refer to the [relevant API documentation](https://learn.microsoft.com/en-us/graph/api/overview?view=graph-rest-1.0) for more details.
:::

| Parameter Name | Description | Required/Optional | Default |
|-----------------------|-----------------------------------------------------------------------------------------------------|-------------------|-------------|
| name | Name of the API (custom name) | Optional | `azure api` |
Expand Down
4 changes: 4 additions & 0 deletions docs/shipping/Azure/azure-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,10 @@ apis:
days_back_fetch: 30
```
:::note
You can customize the endpoints to collect data by adding or modifying the configurations under the `apis` section. Refer to the [relevant API documentation](https://learn.microsoft.com/en-us/graph/api/overview?view=graph-rest-1.0) for more details.
:::

| Parameter Name | Description | Required/Optional | Default |
|-----------------------|-----------------------------------------------------------------------------------------------------|-------------------|-------------|
| name | Name of the API (custom name) | Optional | `azure api` |
Expand Down
4 changes: 4 additions & 0 deletions docs/shipping/Azure/azure-mail-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ apis:

```

:::note
You can customize the endpoints to collect data by adding or modifying the configurations under the `apis` section. Refer to the [relevant API documentation](https://learn.microsoft.com/en-us/previous-versions/office/developer/o365-enterprise-developers/jj984320(v=office.15)) for more details.
:::

| Parameter Name | Description | Required/Optional | Default |
|-----------------------|-----------------------------------------------------------------------------------------------------|-------------------|-------------|
| name | Name of the API (custom name) | Optional | `azure api` |
Expand Down
4 changes: 4 additions & 0 deletions docs/shipping/Azure/azure-security-center.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ apis:

```

:::note
You can customize the endpoints to collect data by adding or modifying the configurations under the `apis` section. Refer to the [relevant API documentation](https://learn.microsoft.com/en-us/graph/api/overview?view=graph-rest-1.0) for more details.
:::

| Parameter Name | Description | Required/Optional | Default |
|-----------------------|-----------------------------------------------------------------------------------------------------|-------------------|-------------|
| name | Name of the API (custom name) | Optional | `azure api` |
Expand Down
2 changes: 1 addition & 1 deletion docs/shipping/Network/cloudflare.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ logzio:
```
:::note
You can customize the endpoints to collect data from by adding extra API configurations under `apis`.
You can customize the endpoints to collect data by adding or modifying the configurations under the `apis` section. Refer to the [relevant API documentation](https://developers.cloudflare.com/api/) for more details.
:::

### Cloudflare configuration options
Expand Down
4 changes: 4 additions & 0 deletions docs/shipping/Other/microsoft-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ apis:
days_back_fetch: 30
```
:::note
You can customize the endpoints to collect data by adding or modifying the configurations under the `apis` section. Refer to the [relevant API documentation](https://learn.microsoft.com/en-us/graph/api/overview?view=graph-rest-1.0) for more details.
:::

| Parameter Name | Description | Required/Optional | Default |
|-----------------------|-----------------------------------------------------------------------------------------------------|-------------------|-------------|
| name | Name of the API (custom name) | Optional | `azure api` |
Expand Down
2 changes: 1 addition & 1 deletion docs/shipping/Security/one-password.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ logzio:
```
:::note
You can customize the endpoints to collect data from by adding extra API configurations under `apis`. 1Password API Docs can be found [here](https://developer.1password.com/docs/connect/connect-api-reference/).
You can customize the endpoints to collect data by adding or modifying the configurations under the `apis` section. Refer to the [relevant API documentation](https://developer.1password.com/docs/connect/connect-api-reference/) for more details.
:::

### 1Password configuration options
Expand Down
4 changes: 4 additions & 0 deletions docs/user-guide/log-management/api-fetcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ apis:
response_data_path: result
```
:::note
You can customize the endpoints to collect data by adding or modifying the configurations under the `apis` section. Refer to the relevant API documentation for more details.
:::

## Configuration
Create a local config file `config.yaml`.

Expand Down
2 changes: 1 addition & 1 deletion static/manifest.json

Large diffs are not rendered by default.

0 comments on commit 2aa83a7

Please sign in to comment.