Skip to main content

Get the list of Alert Definitions​

Select

SaaS
Customer Managed

Get the list of Alert Definitions

Query Parameters
  • additionalProperties boolean

    To get extra meta data details for the api

Responses

Success

Schema
  • alertDefinitions object[]
  • id int32

    Id of the alert definition

  • name string

    Name of the alert definition

  • type string

    Possible values: [Clients, Edge drive-Share operations, License, MediaAgents, Users, Client Group License Usage Check, Data aging is disabled for n days, Expiring clones, Index Backup Status, Index State, Notify decommissioned Virtual Machines, Auxiliary Copy, Data Aging, Data Protection, Data Recovery, DeDup DB Reconstruction, Disaster Recovery Backup, Device Status, Library Management, Admin Alert, Event Viewer Events, Updates Available to Download, No DDB Verification Job in last n days, HyperScale-HardwareAlerts]

    category of the alert definition

  • company object
  • id int32
  • name string
  • enabled boolean

    denotes if the alert definition is enabled or disabled

  • globalConfigInfo object

    Only applicable on Global CommCells

  • id string
  • name string
  • commcells object[]

    List of Service CommCells where the global configuration is applied

  • id int32
  • name string
  • guid string
  • scope string

    The entity level at which the config is applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string used for filtering the scope

  • applyOnAllCommCells boolean

    Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  • isMarkedForDeletion boolean

    Indicates whether global configuration deletion has been started.

  • status string
  • globalConfigInfo object

    Only applicable on Global CommCells

  • id string
  • name string
  • commcells object[]

    List of Service CommCells where the global configuration is applied

  • id int32
  • name string
  • guid string
  • scope string

    The entity level at which the config is applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string used for filtering the scope

  • applyOnAllCommCells boolean

    Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  • isMarkedForDeletion boolean

    Indicates whether global configuration deletion has been started.

  • status string
GET /v4/alertdefinitions

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
additionalProperties — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/AlertDefinitions' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'