Document toolboxDocument toolbox

Working with alert definitions using the API

Overview

Check the list of available endpoints and methods to work with alert definitions using the Alerts API:

Endpoints and methods

Description

Endpoints and methods

Description

GET /alertDefinitions see below

Get the list of all the alerts defined in a domain.

POST /alertDefinitions see below

Create a new alert definition.

POST /alertDefinitions/batch see below

Create a set of new alert definitions.

PUT /alertDefinitions see below

Update a specific alert definition.

PUT /alertDefinitions/batch see below

Update a set of alert definitions.

PUT /alertDefinitions/{id}/deliveryPolicy see below

Assign a sending policy to a specific alert definition.

PUT /alertDefinitions/status see below

Update the status of several alert definitions in bulk.

DELETE /alertDefinitions see below

Delete alert definitions in bulk.

Endpoints and methods

GET /alertDefinitions

Get the list of all the alerts defined in a given domain.

POST /alertDefinitions

Create a new alert definition.

POST /alertDefinitions/batch

Create a set of new alert definitions.

PUT /alertDefinitions

Update a specific alert definition in your domain.

PUT /alertDefinitions/batch

Update a set of alert definitions in your domain.

PUT /alertDefinitions/{id}/deliveryPolicy

Assign a sending policy to a specific alert definition in your domain.

PUT /alertDefinitions/status

Use this operation to enable or deactivate several alerts at the same time.

DELETE /alertDefinitions

Delete alert definitions in bulk.