From 0119986eb8e19c195961d3d51ea1dbed2190314e Mon Sep 17 00:00:00 2001 From: Barak Atias <54084624+brookatlas@users.noreply.github.com> Date: Mon, 23 Oct 2023 20:48:45 +0300 Subject: [PATCH] =?UTF-8?q?added=20some=20of=20the=20params=20undisclosed?= =?UTF-8?q?=20in=20the=20API.=20still=20missing=20more=20i=E2=80=A6=20(#33?= =?UTF-8?q?80)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * added some of the params undisclosed in the API. still missing more info for missing and searchString Signed-off-by: Barak Atias * Update _observing-your-data/alerting/api.md Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Signed-off-by: Heather Halter * Added tick marks to parameters * Update _observing-your-data/alerting/api.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter * Update _observing-your-data/alerting/api.md Co-authored-by: Nathan Bower Signed-off-by: Heather Halter * Update api.md --------- Signed-off-by: Barak Atias Signed-off-by: Heather Halter Co-authored-by: root Co-authored-by: Heather Halter Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Co-authored-by: Nathan Bower --- _observing-your-data/alerting/api.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/_observing-your-data/alerting/api.md b/_observing-your-data/alerting/api.md index 846098a48c..c6b2b1463b 100644 --- a/_observing-your-data/alerting/api.md +++ b/_observing-your-data/alerting/api.md @@ -1344,6 +1344,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