AvantGuard - CIPP icon

AvantGuard - CIPP

AvantGuard - CIPP

Actions136

Overview

This node, named "AvantGuard - CIPP," is designed to interact with the AvantGuard API, specifically targeting operations related to the "List" resource and the "Retrieve Exec Graph Request" operation. It facilitates querying execution graph requests from the AvantGuard service, which can be useful for monitoring or analyzing execution flows within that system.

Typical use cases include:

  • Retrieving detailed execution graph data for auditing or troubleshooting.
  • Integrating AvantGuard execution data into workflows for further processing or visualization.
  • Automating retrieval of execution graphs based on tenant filters and endpoints.

Properties

Name Meaning
Disablepagination A string value to control whether pagination is disabled in the API request.
Endpoint The specific endpoint parameter used to filter or specify the target execution graph.
Tenantfilter A string used to filter results by tenant, allowing multi-tenant data segregation.

All three properties are required and sent as query parameters in the API request.

Output

The node outputs JSON data representing the response from the AvantGuard API's execution graph retrieval endpoint. This JSON typically contains structured information about execution graphs, such as nodes, edges, statuses, timestamps, or other metadata relevant to the execution flow.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard API.
  • Depends on the base URL provided by the user's credentials (resourceApiUrl), which should point to the AvantGuard API endpoint.
  • Uses the @avantguardllc/n8n-openapi-node package to build properties and handle OpenAPI-based requests.
  • The node expects the environment to have network access to the AvantGuard API.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid or missing query parameters (disablepagination, endpoint, tenantfilter) may result in empty responses or errors.
    • Network connectivity problems to the specified API base URL.
  • Error messages:
    • Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
    • Validation errors may occur if required query parameters are omitted or malformed; ensure all required fields are correctly set.
    • Timeout or connection errors suggest network issues; check firewall and proxy settings.

Links and References

  • AvantGuard official API documentation (not provided in source, consult AvantGuard resources).
  • n8n documentation on creating custom nodes and using OpenAPI integrations: https://docs.n8n.io/integrations/creating-nodes/
  • @avantguardllc/n8n-openapi-node package repository or documentation (if publicly available).

Discussion