Fetch full alert profile details for a given profile id

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns profile metadata, notification settings, deployment state, and rule definitions.

Request URL

https://{serverurl}/intelligence/api/alerts/fetchRule/{profileId}

Scope

DesktopCentralCloud.DEX.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/alertRuleDetails.v1+jsonapplication/alertRuleDetails.v1+jsonCopied!

- Path Parameters

profileIdstringMandatory

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/intelligence/api/alerts/fetchRule/{profileId} \
  --header 'Accept: application/alertRuleDetails.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
profileIdlong

Alert profile identifier

ruleNamestring

Alert profile name

descriptionstring

Alert profile description

createdTimestring

Formatted creation time

modifiedTimestring

Formatted modification time

createdBystring

User name of creator

lastModifiedBystring

User name of last modifier

alertTypestring

Alert type. Individual or Grouped

endpointsCountlong

Grouped alert threshold endpoints count

monitoringIntervallong

Monitoring interval in minutes

prioritystring

Priority of the alert profile

coolOffPeriodlong

Cool-off period in minutes

notificationJSON Object

Notification configuration details

Show Sub-Attributes
enabledboolean

Whether notification is enabled for the profile

notificationGroupIdlong

Notification group identifier when available

emailJSON Object

Email notification channel details

Show Sub-Attributes
templateIdlong

Email template identifier associated with notification group

addressesarray

Configured recipient email addresses

isUsedInDeploymentboolean

Indicates whether profile is used in deployment

rulesJSON Array

Configured rules for the profile

Show Sub-Attributes
JSON Object
Show Sub-Attributes
metricKeystring

Metric key identifying this rule template

ruleNamestring

Localized rule display name

ruleStatusboolean

Rule status flag

rulePatternstring

Localized display pattern for rendering UI conditions

ruleParamsJSON Object

Parameter metadata map keyed by index

Show Sub-Attributes
numericforidsJSON Object

Rule parameter metadata object keyed by index

Show Sub-Attributes
ruleParamTemplateIdstring

Rule parameter template identifier

ruleUnitstring

Current display unit for this parameter

paramValuestring

Current/default value for this parameter

displayUnitCategorystring

Unit category used for conversion and validation

minimumValuelong

Minimum allowed value after unit conversion

maximumValuelong

Maximum allowed value after unit conversion

unitOptionsarray

Allowed display units for the parameter

showActionButtonboolean

Indicates if actions are available for current user

actionsarray

Allowed action list for current user

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

Internal server error code for fetch rule operation

errorMessagestring

Internal server error message for fetch rule operation

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Profile details with notification and rules

Copied!
  {
    "modifiedTime": "Apr 02, 2026 10:15 AM",
    "alertType": "Grouped",
    "lastModifiedBy": "admin",
    "description": "Alert when CPU usage is sustained above threshold",
    "rules": [
      {
        "metricKey": "301",
        "ruleName": "CPU Usage",
        "rulePattern": "CPU usage above {0} for {1}",
        "ruleStatus": true,
        "ruleParams": {
          "0": {
            "minimumValue": 1,
            "ruleUnit": "%",
            "ruleParamTemplateId": "7001",
            "unitOptions": [
              "%"
            ],
            "maximumValue": 100,
            "paramValue": "90",
            "displayUnitCategory": "percentage"
          }
        }
      }
    ],
    "priority": "High",
    "endpointsCount": 5,
    "notification": {
      "notificationGroupId": 2001,
      "enabled": true,
      "email": {
        "addresses": [
          "ops-team@example.com"
        ],
        "templateId": 901
      }
    },
    "createdBy": "admin",
    "profileId": 1051,
    "coolOffPeriod": 30,
    "monitoringInterval": 5,
    "ruleName": "High CPU Spike",
    "createdTime": "Apr 01, 2026 09:00 AM",
    "isUsedInDeployment": false,
    "showActionButton": true,
    "actions": [
      "modify",
      "deploy",
      "delete"
    ]
  }
                
Show full

Sample Response: HTTP 500

Unexpected failure while fetching profile details

Copied!
  {
    "errorMessage": "Unable to fetch alert profile details due to internal error",
    "errorCode": "INTERNAL_ERROR"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.