Endpoint
/api/v2/tenants/{tenantId}/policies/alertprediction

This endpoint list all the alert prediction policies of the client.

Path Parameters
tenantId
string

Describes the clientId

Query Parameters
pageNo
integer

pageSize
integer

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.enabledMode
To enable an alert prediction policy, set "enabledMode": "ON". To disable an alert prediction policy, set "enabledMode: "OFF"
results.filterCriteria
Determine if the alert prediction policy should consider the below filter rules.
results.id
uuid of the policy.
results.name
The name of the alert prediction policy.
results.seasonalityTimeFrame
Learning based on the data for last N days.
totalPages
integer

totalResults
integer

{
  "descendingOrder": false,
  "nextPage": false,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "enabledMode": "ON",
      "id": "POLICY-APP-92012ed3-61d7-4291-883c-27a892a5468a",
      "name": "API-01"
    },
    {
      "enabledMode": "ON",
      "id": "POLICY-APP-420ad7bc-c757-49b7-90f3-2b4ff5403e05",
      "name": "API-02"
    },
    {
      "enabledMode": "ON",
      "id": "POLICY-APP-999479b4-2791-4d2f-b0e3-955b7f44130a",
      "name": "API-03"
    },
    {
      "enabledMode": "ON",
      "id": "POLICY-APP-c73535ae-c50f-4a62-bc5c-75f03ffa1830",
      "name": "API-03"
    },
    {
      "enabledMode": "ON",
      "id": "POLICY-APP-2ed7be75-b7d8-442d-adc0-d0c9b6dd1374",
      "name": "Alert Prediction Policy"
    }
  ],
  "totalPages": 1,
  "totalResults": 5
}
Endpoint
/api/v2/tenants/{tenantId}/policies/alertprediction

This endpoint creates a new alert prediction policy of the client.

Path Parameters
tenantId
string

Describes the clientId

enabledMode
string

To enable an alert prediction policy, set "enabledMode": "ON". To disable an alert prediction policy, set "enabledMode: "OFF"

filterCriteria
object

Determine if the alert prediction policy should consider the below filter rules.

filterCriteria.filterBased
Enable filter based rules.
filterCriteria.matchingType
Match ALL or ANY of the rules to filter for resources whose alerts will match this policy.
filterCriteria.rules
id
string

uuid of the policy.

name
string

The name of the alert prediction policy.

seasonalityTimeFrame
string

Learning based on the data for last N days.

{
  "filterCriteria": {
    "filterBased": "true",
    "matchingType": "ALL",
    "rules": [
      {
        "entityName": "resource_name",
        "entityValue": "vm",
        "filterType": "nativeAttributes",
        "operator": "Starts With"
      }
    ]
  },
  "name": "Alert Prediction Policy",
  "seasonalityTimeFrame": "10D"
}

Responses

OK

enabledMode
string

To enable an alert prediction policy, set "enabledMode": "ON". To disable an alert prediction policy, set "enabledMode: "OFF"

filterCriteria
object

Determine if the alert prediction policy should consider the below filter rules.

filterCriteria.filterBased
Enable filter based rules.
filterCriteria.matchingType
Match ALL or ANY of the rules to filter for resources whose alerts will match this policy.
filterCriteria.rules
id
string

uuid of the policy.

name
string

The name of the alert prediction policy.

seasonalityTimeFrame
string

Learning based on the data for last N days.

{
  "enabledMode": "ON",
  "id": "POLICY-APP-594bc866-6702-462d-88ba-04aa3fdc26ed",
  "name": "Alert Prediction Policy"
}