CIPP icon

CIPP

CIPP-API is an Azure Function App providing the logic layer for the CIPP platform. This spec is auto-generated via static analysis of both the API (PowerShell) and frontend (React/Next.js) repositories. Last generated: 2026-03-02.

Actions75

TenantAdministrationAlerts → ListAlertsQueue

AI-generated

Overview

The TenantAdministrationAlerts - ListAlertsQueue operation retrieves a list of alerts from the alerts queue. It supports fetching either all alerts or a single page of results, with optional filtering through additional fields such as preset, logbook, actions, alert comment, command, recurrence, start date time, and post execution. This operation is useful for monitoring and managing alert queues in tenant administration scenarios.

Use Case Examples

  1. Fetch all alerts from the alerts queue to monitor tenant alert status.
  2. Retrieve a single page of alerts filtered by a specific preset or logbook for targeted alert management.

Properties

Name Meaning
Return All Whether to return all results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned.
Additional Fields Optional filters to refine the alerts queue list, including preset, logbook, actions, alert comment, command, recurrence, start date time, and post execution.

Output

JSON

  • json - The list of alerts retrieved from the alerts queue

Dependencies

  • An API key credential for authenticating with the CIPP API

Troubleshooting

  • Ensure the tenant filter and any additional fields are correctly specified to avoid empty or incorrect results.
  • If pagination is enabled, verify pagination parameters to ensure complete data retrieval.
  • Check API credentials and network connectivity if requests fail or time out.

Links

Discussion