Skip to main content

Alert custom rule details​

Select

SaaS
Customer Managed

Get the details of the custom alert rule by Id

Path Parameters
  • alertRuleId int32 required

    Unique Id of the alert custom rule to get details

Responses

Success

Schema
  • queryEntities object[]

    list of query entities

  • isQueryModifyEnabled boolean
  • visibility int32

    whether its private or public

  • sqlQuery string
  • doesQuerySupportOutputFilter boolean
  • frequency int32
  • isOverwriteAssociationAtAlertAllowed boolean
  • isSystemCreated boolean

    whether its system created or not

  • isPrimaryKeyPresent boolean

    whether primary key is present or not

  • isDisabled boolean

    whether its disabled or not

  • queryDescription string

    brief description of the query

  • queryCriteriaName string

    criteria name of the query

  • customAlertType int32

    alert type enum value

  • creator object

    details of the query creator

  • userName string

    name of the query creator

  • userId int32

    unique id of the user

  • additionalQueryDetails object

    contains additional query details

  • querySeverity string

    Possible values: [NONE, CRITICAL, WARNING, INFORMATION]

    Default value: NONE

    query severity level value

  • scriptDescription object

    contains script details

  • reportName string

    name of the report

  • description string
  • guid string

    unique identifier for the script

  • queryEntity object

    contains query details

  • queryId int32

    unique id of the query

  • queryName string

    name of the query

  • queryOutputColumns object[]

    list of the output columns associated with the alert rule

  • isColumnFilterable boolean
  • lmDataType int32
  • isPrimaryKey boolean
  • columnFriendlyName string
  • columnName string
  • securityAssociations object

    contains associations

  • associations object[]

    contains list of security associations

  • ref 
GET /alert/customrule/:alertruleid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
alertRuleId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Alert/CustomRule/:alertRuleId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'