AvantGuard - NinjaOne icon

AvantGuard - NinjaOne

AvantGuard - NinjaOne

Actions159

Overview

The node integrates with the AvantGuard NinjaOne API to retrieve integrity check job records related to backups. Specifically, the "Get Integrity Check Jobs" operation fetches a list of backup integrity check jobs, allowing users to filter and paginate the results based on various criteria.

This node is useful in scenarios where IT administrators or automation workflows need to monitor backup integrity checks, audit backup statuses, or analyze backup job details programmatically. For example, it can be used to generate reports on backup health, trigger alerts if certain backup jobs fail integrity checks, or synchronize backup job data with other systems.

Properties

Name Meaning
Additional Query Parameters Optional filters and pagination controls for the request:
- Df Device filter (string)
- Ddf Deleted device filter (string)
- Sf Backup job status filter (string)
- Ptf Backup job planType filter (string)
- Stf Backup job startTime filter (string)
- Include Which devices to include: active, deleted, or all (default: active)
- Cursor Cursor name for pagination (string)
- Page Size Limit number of records per page (number, default: 10000)

These parameters allow fine-tuning the query to retrieve only relevant integrity check jobs, control result size, and navigate through paginated data.

Output

The node outputs JSON data representing the retrieved integrity check jobs from the NinjaOne API. The structure typically includes an array of job objects containing details such as device information, job status, timestamps, and other metadata related to backup integrity checks.

If the API supports binary data output (not indicated here), it would be summarized accordingly, but this node primarily returns structured JSON data.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard NinjaOne API.
  • The base URL for the API must be configured in the node credentials.
  • No additional external dependencies are indicated beyond the NinjaOne API access.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect filter values may result in empty responses or errors.
    • Large page sizes might lead to timeouts or performance issues.
  • Error Messages:

    • Authentication errors typically indicate invalid API keys or misconfigured credentials.
    • Validation errors may occur if query parameters do not conform to expected formats.
    • Pagination errors can happen if cursor values are incorrect or expired.
  • Resolutions:

    • Verify that the API key credential is correctly set up and has necessary permissions.
    • Double-check filter parameter values for correctness.
    • Use reasonable page sizes and valid cursors for pagination.

Links and References

Discussion