v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Policies

Enable the global alert policy

post/api/{cloudId}/v1/alerts/policies/{policyId}/enable

Path parameters

policyIdstring required

Identifier of the policy.

Response

Returned if the request is successful.

typestring

idstring

namestring

descriptionstring

teamIdstring

enabledboolean

ordernumber

aliasstring

messagestring

alertDescriptionstring

sourcestring

entitystring

respondersstring[]

actionsstring[]

tagsstring[]

detailsobject

continueboolean

updatePriorityboolean

If set to true, priority of the alert will be updated based on priorityValue. Default value is false

priorityValue'P1' | 'P2' | 'P3' | 'P4' | 'P5'

Priority value of the alert. Should be one of P1, P2, P3, P4, or P5. This field is used when updatePriority is set to true.

keepOriginalRespondersboolean

keepOriginalDetailsboolean

keepOriginalActionsboolean

keepOriginalTagsboolean

Example response

{
  "type": "ALERT",
  "id": "5422f159-0ca5-4fd9-9f73-770b2778baa3",
  "name": "test 2",
  "description": "asdasd",
  "enabled": true,
  "filter": {
    "type": "match-any-condition",
    "conditions": [
      {
        "field": "message",
        "operation": "contains",
        "expectedValue": "asd"
      }
    ]
  },
  "timeRestriction": {
    "enabled": true,
    "timeRestrictions": [
      {
        "endHour": 1
      }
    ],
    "appliedTimeZone": "(GMT+03:00) Europe/Istanbul TRT"
  },
  "alias": "{{alias}}",
  "message": "{{message}} asd",
  "alertDescription": "{{description}}",
  "source": "{{source}}",
  "entity": "{{entity}}",
  "responders": [],
  "actions": [],
  "tags": [],
  "priorityValue": "P3",
  "keepOriginalResponders": true,
  "keepOriginalDetails": true,
  "keepOriginalActions": true,
  "keepOriginalTags": true
}