AvantGuard - NinjaOne icon

AvantGuard - NinjaOne

AvantGuard - NinjaOne

Actions159

Overview

The node integrates with the AvantGuard NinjaOne API to retrieve a custom fields report related to queries. It allows users to fetch detailed information about custom fields, optionally filtered and paginated according to various parameters. This node is useful in scenarios where you need to analyze or export custom field data from NinjaOne for reporting, auditing, or integration with other systems.

For example, you might use this node to:

  • Extract all custom fields updated after a certain date to synchronize with an external database.
  • Retrieve a paginated list of custom fields with specific filters applied, such as device filters or secure value visibility.
  • Generate reports on custom fields usage across devices or assets managed in NinjaOne.

Properties

Name Meaning
Additional Query Parameters Optional query parameters to customize the request:
- Df Device filter — filter results by device identifier or criteria.
- Cursor Cursor name — used for pagination to continue fetching subsequent pages.
- Page Size Limit number of records per page (default 1000).
- Updated After Custom fields updated after the specified date (ISO string).
- Fields Comma-separated list of fields to include in the response.
- Show Secure Values Boolean flag indicating if secure values should be returned as plain text without encryption (default true).

These parameters allow fine-tuning of the API call to get exactly the subset of custom fields data needed.

Output

The node outputs JSON data representing the custom fields report retrieved from the NinjaOne API. The structure typically includes an array of custom field objects, each containing details such as field names, values, update timestamps, and possibly secure values depending on the showSecureValues flag.

If the API supports binary data for any part of the response (not indicated here), it would be included accordingly, but based on the provided code and properties, the output is purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard NinjaOne API.
  • Needs the base URL of the NinjaOne API configured in the credentials.
  • Depends on the @avantguardllc/n8n-openapi-node package for OpenAPI-based request handling.
  • The node uses the OpenAPI specification defined in openapi.json bundled with the source.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly set up and has sufficient permissions.
  • Invalid query parameters: Passing unsupported or malformed parameters may cause API errors; verify parameter formats, especially dates and numeric limits.
  • Pagination issues: If using cursors, ensure correct handling of the cursor token to avoid missing or repeating data.
  • Empty responses: May occur if filters are too restrictive or no data matches the criteria; try broadening filters or removing optional parameters.
  • Network or connectivity problems: Check network access to the NinjaOne API endpoint and proxy/firewall settings.

Links and References

Discussion