Skip to main content

Edit Alert Definitions​

Edit Alert Definition details

Path Parameters
  • id int32 required
Request Body
  • newName string

    The new name of the alert definition

  • sendIndividualNotifications boolean
  • associationsOperationType string

    Possible values: [ADD, DELETE, OVERWRITE]

    Default value: ADD

    Allows adding to, overwriting and deleting existing alert associations. default is adding to existing alert associations

  • associations object[]
  • id int32

    id of the associated entity

  • name string

    name of the associated entity

  • type string

    Possible values: [ALL_SERVERS, ALL_SERVER_GROUPS_ENTITY, SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY, SUBCLIENT_ENTITY, REPLICATION_PAIR_ENTITY, BLR_PAIR_ENTITY, FS_REPLICATION_PAIR_ENTITY]

  • parentEntity1 object

    parentEntity1 can only have type SERVER_ENTITY.parentEntity2 can only have type APPTYPE_ENTITY.parentEntity3 can only have type INSTANCE_ENTITY.parentEntity4 can only have type BACKUPSET_ENTITY.

  • id int32

    id of the associated entity

  • name string

    name of the associated entity

  • type string

    Possible values: [SERVER_ENTITY, BACKUPSET_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY]

  • parentEntity2 object

    parentEntity1 can only have type SERVER_ENTITY.parentEntity2 can only have type APPTYPE_ENTITY.parentEntity3 can only have type INSTANCE_ENTITY.parentEntity4 can only have type BACKUPSET_ENTITY.

  • id int32

    id of the associated entity

  • name string

    name of the associated entity

  • type string

    Possible values: [SERVER_ENTITY, BACKUPSET_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY]

  • parentEntity3 object

    parentEntity1 can only have type SERVER_ENTITY.parentEntity2 can only have type APPTYPE_ENTITY.parentEntity3 can only have type INSTANCE_ENTITY.parentEntity4 can only have type BACKUPSET_ENTITY.

  • id int32

    id of the associated entity

  • name string

    name of the associated entity

  • type string

    Possible values: [SERVER_ENTITY, BACKUPSET_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY]

  • parentEntity4 object

    parentEntity1 can only have type SERVER_ENTITY.parentEntity2 can only have type APPTYPE_ENTITY.parentEntity3 can only have type INSTANCE_ENTITY.parentEntity4 can only have type BACKUPSET_ENTITY.

  • id int32

    id of the associated entity

  • name string

    name of the associated entity

  • type string

    Possible values: [SERVER_ENTITY, BACKUPSET_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY]

  • alertTarget object

    Please note CONTENT_INDEX will be returned at all times as it is enabled at all times.

  • sendAlertTo string[]

    Possible values: [LIVEFEEDS, SNMP, WEBHOOK, EMAIL, APPLOG, CONTENT_INDEX]

  • recipientsOperationType string

    Possible values: [ADD, DELETE, OVERWRITE]

    Allows adding to, overwriting and deleting existing recipients. default is adding to existing recipients

  • recipients object
  • to object[]
  • id int32
  • name string
  • type string

    Possible values: [USER, USER_GROUP, EMAIL, AD_USERGROUP]

  • cc object[]
  • id int32
  • name string
  • type string

    Possible values: [USER, USER_GROUP, EMAIL, AD_USERGROUP]

  • bcc object[]
  • id int32
  • name string
  • type string

    Possible values: [USER, USER_GROUP, EMAIL, AD_USERGROUP]

  • webHookId int32

    id of the webhook to be associated with the alert definition. Only needed incase of webhook notif selected. To get a list of webhooks, use api GET Webhook

  • templates object
  • locale object
  • id int32
  • name string
  • email string

    the message template for the email notification. Contains both email subject as well as body

  • console string

    the message template for the console notification

  • eventViewer string

    the message template for the event viewer notification

  • webhook string

    the message template for the webhook notification

Responses

Success

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/alertdefinitions/:id

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
id — path required
Body
{

  "newName": "string",

  "sendIndividualNotifications": true,

  "associationsOperationType": "ADD",

  "associations": [

    {

      "id": 0,

      "name": "string",

      "type": "ALL_SERVERS",

      "parentEntity1": {

        "id": 0,

        "name": "string",

        "type": "SERVER_ENTITY"

      },

      "parentEntity2": {

        "id": 0,

        "name": "string",

        "type": "SERVER_ENTITY"

      },

      "parentEntity3": {

        "id": 0,

        "name": "string",

        "type": "SERVER_ENTITY"

      },

      "parentEntity4": {

        "id": 0,

        "name": "string",

        "type": "SERVER_ENTITY"

      }

    }

  ],

  "alertTarget": {

    "sendAlertTo": [

      "LIVEFEEDS"

    ],

    "recipientsOperationType": "ADD",

    "recipients": {

      "to": [

        {

          "id": 0,

          "name": "string",

          "type": "USER"

        }

      ],

      "cc": [

        {

          "id": 0,

          "name": "string",

          "type": "USER"

        }

      ],

      "bcc": [

        {

          "id": 0,

          "name": "string",

          "type": "USER"

        }

      ],

      "webHookId": 0

    }

  },

  "templates": {

    "locale": {

      "id": 0,

      "name": "string"

    },

    "email": "string",

    "console": "string",

    "eventViewer": "string",

    "webhook": "string"

  }

}

curl -L -X PUT 'https://localhost/webconsole/api/V4/AlertDefinitions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "sendIndividualNotifications": true,
  "associationsOperationType": "ADD",
  "associations": [
    {
      "id": 0,
      "name": "string",
      "type": "ALL_SERVERS",
      "parentEntity1": {
        "id": 0,
        "name": "string",
        "type": "SERVER_ENTITY"
      },
      "parentEntity2": {
        "id": 0,
        "name": "string",
        "type": "SERVER_ENTITY"
      },
      "parentEntity3": {
        "id": 0,
        "name": "string",
        "type": "SERVER_ENTITY"
      },
      "parentEntity4": {
        "id": 0,
        "name": "string",
        "type": "SERVER_ENTITY"
      }
    }
  ],
  "alertTarget": {
    "sendAlertTo": [
      "LIVEFEEDS"
    ],
    "recipientsOperationType": "ADD",
    "recipients": {
      "to": [
        {
          "id": 0,
          "name": "string",
          "type": "USER"
        }
      ],
      "cc": [
        {
          "id": 0,
          "name": "string",
          "type": "USER"
        }
      ],
      "bcc": [
        {
          "id": 0,
          "name": "string",
          "type": "USER"
        }
      ],
      "webHookId": 0
    }
  },
  "templates": {
    "locale": {
      "id": 0,
      "name": "string"
    },
    "email": "string",
    "console": "string",
    "eventViewer": "string",
    "webhook": "string"
  }
}'