NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Related Items → Get Related Items For Host Entity

AI-generated

Overview

This node interacts with the NinjaOne API to retrieve related items for a specified host entity. It is useful in scenarios where you want to find entities connected to a particular host, such as organizations, documents, locations, nodes, checklists, or knowledge base documents. For example, you might use this node to get all documents related to a specific organization or all nodes hosted by a certain location.

Properties

Name Meaning
Entity Type The type of the host entity. Options: ORGANIZATION, DOCUMENT, LOCATION, NODE, CHECKLIST, KB DOCUMENT
Entity Id The unique identifier (number) of the host entity
Scope The relationship scope to filter related items. Options: ALL (all related), HOSTING (items hosting the entity), HOSTED BY (items hosted by the entity)

Output

The node outputs an array of JSON objects representing the related items retrieved from the NinjaOne API for the specified host entity. Each item contains the data fields returned by the API describing the related entity. There is no binary output for this operation.

Dependencies

  • Requires an active connection to the NinjaOne API using OAuth2 authentication.
  • The node expects the NinjaOne API credentials to be configured in n8n.
  • No additional environment variables are required beyond the API credential setup.

Troubleshooting

  • Common issues:

    • Invalid or missing entity ID or entity type parameters will cause the API request to fail.
    • Incorrect scope values may result in empty results or unexpected data.
    • Authentication errors if the NinjaOne API credentials are not set up correctly or have expired.
  • Error messages:

    • Errors from the NinjaOne API will be returned in the node's output under an error field if "Continue On Fail" is enabled.
    • Typical errors include "Unauthorized" (check API credentials), "Not Found" (verify entity ID and type), or "Bad Request" (invalid parameters).
  • Resolution:

    • Verify that the entity type and entity ID are correct and correspond to existing records in NinjaOne.
    • Ensure the API credentials are valid and have necessary permissions.
    • Use the "Scope" property appropriately to match the desired relationship direction.

Links and References

Discussion