Endpoint
/api/v2/tenants/{tenantId}/polices/alertprediction/{policyId}
Path Parameters
tenantId
string

Describes the client ID

policyId
string

Policy unique identifier

Responses

OK

Endpoint
/api/v2/tenants/{tenantId}/polices/alertprediction/{policyId}
Path Parameters
tenantId
string

Describes the client ID

policyId
string

Policy unique identifier

Responses

OK

createdBy
object

createdBy.email
createdBy.firstName
createdBy.lastName
createdBy.loginName
createdTime
string

enabledMode
string

filterCriteria
object

filterCriteria.filterBased
filterCriteria.matchingType
filterCriteria.rules
id
string

name
string

updatedTime
string

{
  "createdBy": {
    "email": "helpdesk@opsramp.com",
    "firstName": "API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user",
    "userPreferences": {
      "displayMode": "light"
    }
  },
  "createdTime": "2021-05-21T10:16:53+0100",
  "enabled": false,
  "enabledMode": "ON",
  "filterCriteria": {
    "filterBased": "true",
    "matchingType": "ALL",
    "rules": [
      {
        "entityName": "resource_name",
        "entityValue": "vm",
        "filterType": "nativeAttributes",
        "operator": "Starts With"
      }
    ]
  },
  "id": "POLICY-APP-2ed7be75-b7d8-442d-adc0-d0c9b6dd1374",
  "name": "Alert Prediction Policy",
  "seasonalityTimeFrame": "10D",
  "updatedTime": ""
}
Endpoint
/api/v2/tenants/{tenantId}/polices/alertprediction/{policyId}
Path Parameters
tenantId
string

Describes the client ID

policyId
string

Policy unique identifier

enabledMode
string

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

filterCriteria
object

Filter for resources whose alerts will match this policy.

filterCriteria.filterBased
Determine if the alert prediction policy should consider the below filter rules.
filterCriteria.matchingType
Match ALL or ANY of the rules to filter for resources whose alerts will match this policy.
filterCriteria.rules
(Mandatory if "filterBase": "true") Filter resources with the rules that follow.
name
string

The name of the alert prediction policy.

seasonalityTimeFrame
string

Predict based on the data for last N days.

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

Responses

OK

createdBy
object

createdBy.email
createdBy.firstName
createdBy.lastName
createdBy.loginName
createdTime
string

enabledMode
string

filterCriteria
object

filterCriteria.filterBased
filterCriteria.matchingType
filterCriteria.rules
id
string

name
string

updatedTime
string

{
  "createdBy": {
    "email": "helpdesk@opsramp.com",
    "firstName": "API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user",
    "userPreferences": {
      "displayMode": "light"
    }
  },
  "createdTime": "2021-05-21T10:16:53+0100",
  "enabled": false,
  "enabledMode": "ON",
  "filterCriteria": {
    "filterBased": true,
    "matchingType": "ALL",
    "rules": [
      {
        "entityName": "resource_name",
        "entityValue": "vm",
        "filterType": "nativeAttributes",
        "operator": "Starts with"
      }
    ]
  },
  "id": "POLICY-APP-2ed7be75-b7d8-442d-adc0-d0c9b6dd1374",
  "name": "Alert Prediction Policy",
  "seasonalityTimeFrame": "10D",
  "updatedTime": ""
}
{
  "createdBy": {
    "email": "helpdesk@opsramp.com",
    "firstName": "API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user",
    "userPreferences": {
      "displayMode": "light"
    }
  },
  "createdTime": "2021-05-21T10:18:56+0100",
  "enabled": false,
  "enabledMode": "ON",
  "filterCriteria": {},
  "id": "POLICY-APP-b786fdb7-f675-4253-98ca-66775ed3d1c1",
  "name": "Alert Prediction Policy",
  "seasonalityTimeFrame": "10D",
  "updatedTime": ""
}