Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 2.0] added some of the params undisclosed in the API. still missing more i… #5363

Merged
merged 1 commit into from
Oct 23, 2023
Merged

[Backport 2.0] added some of the params undisclosed in the API. still missing more i… #5363

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions _observing-your-data/alerting/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1126,6 +1126,20 @@ Introduced 1.0

Returns an array of all alerts.

**Path parameters**
The following table lists the available path parameters. All path parameters are optional.
Parameter | Data type | Description
:--- | :--- | :---
`sortString` | String | Determines how to sort the results. Defaults to `monitor_name.keyword`.
`sortOrder` | String | Determines the order of the results. Options are `asc` or `desc`. Defaults to `asc`.
`missing` | String | Optional.
`size` | String | Determines the size of the request to be returned. Defaults to `20`.
`startIndex` | String | The index to start from. Used for paginating results. Defaults to `0`.
`searchString` | String | A search string used to look for a specific alert. Defaults to an empty string.
`severityLevel` | String | The severity level to filter for. Defaults to `ALL`.
`alertState` | String | The alert state to filter for. Defaults to `ALL`.
`monitorId` | String | Filters by monitor ID.

#### Request

```json
Expand Down