Actions75
- EndpointAutopilot Actions
- TenantAdministrationAlerts Actions
- EndpointMEM Actions
- TenantGDAP Actions
- TenantAdministrationApplicationApproval Actions
- TenantAdministration Actions
- CIPPSetup Actions
- Security Actions
- IdentityAdministrationDevices Actions
- CIPPExtensions Actions
- EmailExchangeTools Actions
TenantAdministrationAlerts → AddAlert
AI-generatedOverview
The TenantAdministrationAlerts - AddAlert operation allows users to create a new alert within the tenant administration alerts system. This operation is useful for monitoring and managing alerts related to tenant activities, enabling administrators to specify detailed alert parameters such as actions, comments, commands, conditions, excluded tenants, logbook entries, recurrence, and scheduling details. It supports sending customized alert data to the CIPP API for tenant-specific alert management.
Use Case Examples
- Creating an alert to notify administrators about a specific tenant event with custom actions and comments.
- Scheduling recurring alerts for tenant monitoring with specific conditions and exclusions.
Properties
| Name | Meaning |
|---|---|
| Tenant Filter | The tenant filter used to specify the target tenant for the alert. |
| Actions | JSON array specifying the actions associated with the alert. |
| Alert Comment | A comment or note related to the alert. |
| Command | JSON object representing a command related to the alert, typically used for dropdown selections. |
| Conditions | Conditions that trigger the alert. |
| Excluded Tenants | Tenants excluded from the alert. |
| Logbook | JSON object representing logbook details related to the alert. |
| Post Execution | JSON array specifying post execution actions for the alert. |
| Preset | JSON object representing a preset configuration for the alert. |
| Recurrence | JSON object specifying recurrence details for the alert. |
| Row Key | A unique row key identifier for the alert. |
| Start Date Time | The start date and time for the alert. |
| Count | A count value related to the alert. |
Output
JSON
debug- Debug information including actual URL, query parameters, headers, and body sent for the API requestjson- The response data from the AddAlert API call
Dependencies
- An API key credential for authenticating with the CIPP API
Troubleshooting
- Ensure the tenant filter is correctly specified and corresponds to a valid tenant.
- Verify that all required fields are provided and correctly formatted, especially JSON fields like actions, command, logbook, postExecution, preset, and recurrence.
- Check API authentication credentials and permissions to ensure the request is authorized.
- Enable debug mode to get detailed request and response information for troubleshooting.