Zorus icon

Zorus

Interact with Zorus API

Actions13

Overview

This node integrates with the Zorus API to perform a search operation on "Endpoints." It allows users to query endpoints based on various filtering criteria such as name, UUID, license ID, customer UUID, group UUID, agent state, and error state. The node supports pagination and sorting options, enabling efficient retrieval of endpoint data in manageable chunks.

Common scenarios for this node include:

  • Retrieving a list of active endpoints filtered by specific attributes for monitoring or reporting.
  • Searching for endpoints associated with particular customers, groups, or licenses.
  • Filtering endpoints that are currently in an error state to trigger alerts or remediation workflows.
  • Paginating through large sets of endpoints while sorting them by desired properties.

Practical example:
A security operations team could use this node to fetch all enabled endpoints last seen after a certain date, sorted by their last seen timestamp, to identify recently active devices for vulnerability scanning.

Properties

Name Meaning
Page The page number to retrieve in the paginated results (default is 1).
Page Size Number of items to retrieve per page (default is 10).
Sort Property The property name by which to sort the results (e.g., name, lastSeen).
Sort Ascending Whether to sort the results in ascending order (true) or descending order (false).
Name Contains Filter endpoints whose names contain this string.
Is Enabled Filter endpoints based on whether they are enabled (true) or not (false).
UUID Equals Filter endpoints matching exactly this UUID.
UUID In Filter endpoints whose UUID is in this comma-separated list of UUIDs.
License ID Equals Filter endpoints matching exactly this license ID.
License ID In Filter endpoints whose license ID is in this comma-separated list of IDs.
Customer UUID Equals Filter endpoints matching exactly this customer UUID.
Customer UUID In Filter endpoints whose customer UUID is in this comma-separated list of UUIDs.
Group UUID Equals Filter endpoints matching exactly this group UUID.
Group UUID In Filter endpoints whose group UUID is in this comma-separated list of UUIDs.
Is In Error State Filter endpoints based on whether they are currently in an error state (true/false).
Agent State Equals Filter endpoints matching exactly this agent state.
Last Seen Before Filter endpoints last seen before this date/time (ISO 8601 format expected).
Last Seen After Filter endpoints last seen after this date/time (ISO 8601 format expected).

Output

The node outputs JSON data representing the list of endpoints matching the search criteria. Each item in the output typically contains detailed information about an endpoint, including its identifiers (UUID, license ID), status flags (enabled, error state), timestamps (last seen), and associations (customer UUID, group UUID).

If binary data were involved (not indicated here), it would represent files or attachments related to endpoints, but this node focuses on JSON metadata.

Dependencies

  • Requires an API key credential for authenticating with the Zorus API.
  • The base URL for API requests is https://developer.zorustech.com/api.
  • The node expects the API version header "Zorus-Api-Version": "1.0" to be set.
  • No other external dependencies are indicated.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid filter values: Passing improperly formatted UUIDs or dates may cause API errors; verify input formats.
  • Empty results: If no endpoints match the filters, check if the filter criteria are too restrictive or incorrect.
  • Pagination issues: Confirm that page numbers and page sizes are within valid ranges supported by the API.
  • Sorting errors: Using unsupported sort properties may result in errors or ignored parameters.

Links and References

Discussion