AvantGuard - CIPP icon

AvantGuard - CIPP

AvantGuard - CIPP

Actions136

Overview

This node operation, "Retrieve List Mailbox Restores," is designed to fetch mailbox restore information from a list resource. It is useful in scenarios where users need to obtain detailed restore data for mailboxes, such as auditing restore activities, monitoring restore statuses, or generating reports on mailbox restores within an organization.

Practical examples include:

  • Retrieving mailbox restore records filtered by tenant or identity.
  • Including detailed reports and statistics about mailbox restores.
  • Integrating mailbox restore data into workflows for compliance or backup verification.

Properties

Name Meaning
Identity The identifier of the mailbox or entity for which to retrieve restore information.
Includereport Option to specify whether to include detailed restore reports in the response.
Statistics Option to specify whether to include statistical data related to mailbox restores.
Tenantfilter Filter to restrict results to a specific tenant or group within the system.

Output

The output of this node operation is JSON data containing the mailbox restore information corresponding to the specified query parameters. This includes details about each mailbox restore event, optionally enriched with reports and statistics depending on the input properties.

If binary data were involved (e.g., attachments or files), it would be summarized here, but based on the provided code and properties, the output is purely JSON structured data representing mailbox restore details.

Dependencies

  • Requires an API key credential for authentication to the AvantGuard CIPP service.
  • Needs configuration of the base URL for the API endpoint (resourceApiUrl).
  • Depends on the @avantguardllc/n8n-openapi-node package and the associated OpenAPI specification (openapi.json) bundled with the node.

Troubleshooting

  • Common issues:

    • Missing or incorrect API credentials can cause authentication failures.
    • Incorrect or missing required properties (like Identity, Includereport, Statistics, or Tenantfilter) may result in incomplete or empty responses.
    • Network connectivity problems to the configured API endpoint.
  • Error messages:

    • Authentication errors typically indicate invalid or missing API keys; verify credentials setup.
    • Validation errors may occur if required query parameters are not provided; ensure all required properties are set.
    • Timeout or connection errors suggest network issues or incorrect API base URL configuration.

Links and References

Discussion